-
Notifications
You must be signed in to change notification settings - Fork 25
/
cli.h
90 lines (81 loc) · 2.36 KB
/
cli.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/*
* MIT License
*
* Copyright (c) 2019 Sean Farrelly
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* File cli.h
* Created by Sean Farrelly
* Version 1.0
*
*/
/*! @file cli.h
* @brief Command-line interface API definitions.
*/
/*!
* @defgroup CLI API
*/
#ifndef _CLI_H_
#define _CLI_H_
/*! CPP guard */
#ifdef __cplusplus
extern "C" {
#endif
#include "cli_defs.h"
/*!
* @brief This API initialises the command-line interface.
*
* @param[in] cli : Pointer to cli handle struct.
*
* @return cli_status_t
*/
cli_status_t cli_init(cli_t *cli);
/*!
* @brief This API deinitialises the command-line interface.
*
* @param[in] cli : Pointer to cli handle struct.
*
* @return cli_status_t
*/
cli_status_t cli_deinit(cli_t *cli);
/*!
* @brief This API must be periodically called by the user to process and
* execute any commands received.
*
* @param[in] cli : Pointer to cli handle struct.
*
* @return cli_status_t
*/
cli_status_t cli_process(cli_t *cli);
/*!
* @brief This API should be called from the devices interrupt handler whenever
* a character is received over the input stream.
*
* @param[in] cli : Pointer to cli handle struct.
* @param[in] c : The character received.
*
* @return cli_status_t
*/
cli_status_t cli_put(cli_t *cli, char c);
#ifdef __cplusplus
}
#endif /* End of CPP guard */
#endif /* CLI_H_ */
/** @}*/