-
Notifications
You must be signed in to change notification settings - Fork 86
/
config-pattern
38 lines (36 loc) · 1.11 KB
/
config-pattern
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
/**
* Set the {2} for the specified serial port.
*
* @param[in] port Pointer to a port structure. Must not be NULL.
* @param[in] {0} {3}.
*
* @return SP_OK upon success, a negative error code otherwise.
*
* @since 0.1.0
*/
enum sp_return sp_set_{0}(struct sp_port *port, {1} {0});
/**
* Get the {2} from a port configuration.
*
* The user should allocate a variable of type {1} and
* pass a pointer to this to receive the result.
*
* @param[in] config Pointer to a configuration structure. Must not be NULL.
* @param[out] {0}_ptr Pointer to a variable to store the result. Must not be NULL.
*
* @return SP_OK upon success, a negative error code otherwise.
*
* @since 0.1.0
*/
enum sp_return sp_get_config_{0}(const struct sp_port_config *config, {1} *{0}_ptr);
/**
* Set the {2} in a port configuration.
*
* @param[in] config Pointer to a configuration structure. Must not be NULL.
* @param[in] {0} {3}, or -1 to retain the current setting.
*
* @return SP_OK upon success, a negative error code otherwise.
*
* @since 0.1.0
*/
enum sp_return sp_set_config_{0}(struct sp_port_config *config, {1} {0});