shell_lock.h

Go to the documentation of this file.

/*
 * Copyright (C) 2020 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef SHELL_LOCK_H
#define SHELL_LOCK_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "shell.h"
 
#ifdef MODULE_SHELL_LOCK
    #ifndef CONFIG_SHELL_LOCK_PASSWORD
        #error Using MODULE_SHELL_LOCK requires defining CONFIG_SHELL_LOCK_PASSWORD
    #endif /* CONFIG_SHELL_LOCK_PASSWORD */
#endif /* MODULE_SHELL_LOCK */
 
#define CONFIG_SHELL_LOCK_ATTEMPTS_BEFORE_TIME_LOCK 3
 
#ifndef CONFIG_SHELL_LOCK_AUTO_LOCK_TIMEOUT_MS
#define CONFIG_SHELL_LOCK_AUTO_LOCK_TIMEOUT_MS (5 * 60 * 1000)
#endif
 
void shell_lock_checkpoint(char *line_buf, int buf_size);
 
bool shell_lock_is_locked(void);
 
void shell_lock_do_lock(void);
 
#ifdef MODULE_SHELL_LOCK_AUTO_LOCKING
void shell_lock_auto_lock_refresh(void);
#endif /* MODULE_SHELL_LOCK_AUTO_LOCKING */
 
#ifdef __cplusplus
}
#endif
 
#endif /* SHELL_LOCK_H */