]>
Commit | Line | Data |
---|---|---|
35ff018b ML |
1 | /** |
2 | * Set the {2} for the specified serial port. | |
3 | * | |
35578b06 UH |
4 | * @param[in] port Pointer to a port structure. Must not be NULL. |
5 | * @param[in] {0} {3}. | |
35ff018b ML |
6 | * |
7 | * @return SP_OK upon success, a negative error code otherwise. | |
35578b06 UH |
8 | * |
9 | * @since 0.1.0 | |
35ff018b ML |
10 | */ |
11 | enum sp_return sp_set_{0}(struct sp_port *port, {1} {0}); | |
12 | ||
13 | /** | |
14 | * Get the {2} from a port configuration. | |
15 | * | |
35578b06 UH |
16 | * The user should allocate a variable of type {1} and |
17 | * pass a pointer to this to receive the result. | |
35ff018b | 18 | * |
35578b06 UH |
19 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
20 | * @param[out] {0}_ptr Pointer to a variable to store the result. Must not be NULL. | |
35ff018b ML |
21 | * |
22 | * @return SP_OK upon success, a negative error code otherwise. | |
35578b06 UH |
23 | * |
24 | * @since 0.1.0 | |
35ff018b ML |
25 | */ |
26 | enum sp_return sp_get_config_{0}(const struct sp_port_config *config, {1} *{0}_ptr); | |
27 | ||
28 | /** | |
29 | * Set the {2} in a port configuration. | |
30 | * | |
35578b06 UH |
31 | * @param[in] config Pointer to a configuration structure. Must not be NULL. |
32 | * @param[in] {0} {3}, or -1 to retain the current setting. | |
35ff018b ML |
33 | * |
34 | * @return SP_OK upon success, a negative error code otherwise. | |
35578b06 UH |
35 | * |
36 | * @since 0.1.0 | |
35ff018b ML |
37 | */ |
38 | enum sp_return sp_set_config_{0}(struct sp_port_config *config, {1} {0}); |