saul_reg.h
3.76 KB
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/*
* Copyright (C) 2015 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.
*/
/**
* @defgroup sys_saul_reg SAUL registry
* @ingroup sys
* @brief Global sensor/actuator registry for SAUL devices
*
* @see @ref drivers_saul
*
* @{
*
* @file
* @brief SAUL registry interface definition
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/
#ifndef SAUL_REG_H
#define SAUL_REG_H
#include <stdint.h>
#include "saul.h"
#include "phydat.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief SAUL registry entry
*/
typedef struct saul_reg {
struct saul_reg *next; /**< pointer to the next device */
void *dev; /**< pointer to the device descriptor */
const char *name; /**< string identifier for the device */
saul_driver_t const *driver; /**< the devices read callback */
} saul_reg_t;
/**
* @brief Additional data to collect for each entry
*/
typedef struct {
const char *name; /**< string identifier for a device */
} saul_reg_info_t;
/**
* @brief Export the SAUL registry as global variable
*/
extern saul_reg_t *saul_reg;
/**
* @brief Register a device with the SAUL registry
*
* @note Make sure the registry entry the @p dev pointer is pointing to
* resides in some persistent memory location and not on some position
* on the stack where it will be overwritten...
*
* @param[in] dev pointer to a pre-populated registry entry
*
* @return 0 on success
* @return -ENODEV on invalid entry given
*/
int saul_reg_add(saul_reg_t *dev);
/**
* @brief Unregister a device from the SAUL registry
*
* @param[in] dev pointer to a registry entry
*
* @return 0 on success
* @return -ENODEV if device was not found in the registry
*/
int saul_reg_rm(saul_reg_t *dev);
/**
* @brief Find a device by it's position in the registry
*
* @param[in] pos position to look up
*
* @return pointer to the device at position specified by @p pos
* @return NULL if no device is registered at that position
*/
saul_reg_t *saul_reg_find_nth(int pos);
/**
* @brief Find the first device of the given type in the registry
*
* @param[in] type device type to look for
*
* @return pointer to the first device matching the given type
* @return NULL if no device of that type could be found
*/
saul_reg_t *saul_reg_find_type(uint8_t type);
/**
* @brief Find a device by its name
*
* @param[in] name the name to look for
*
* @return pointer to the first device matching the given name
* @return NULL if no device with that name could be found
*/
saul_reg_t *saul_reg_find_name(const char *name);
/**
* @brief Read data from the given device
*
* @param[in] dev device to read from
* @param[out] res location to store the results in
*
* @return the number of data elements read to @p res [1-3]
* @return -ENODEV if given device is invalid
* @return -ENOTSUP if read operation is not supported by the device
* @return -ECANCELED on device errors
*/
int saul_reg_read(saul_reg_t *dev, phydat_t *res);
/**
* @brief Write data to the given device
*
* @param[in] dev device to write to
* @param[in] data data to write to the device
*
* @return the number of data elements processed by the device
* @return -ENODEV if given device is invalid
* @return -ENOTSUP if read operation is not supported by the device
* @return -ECANCELED on device errors
*/
int saul_reg_write(saul_reg_t *dev, phydat_t *data);
#ifdef __cplusplus
}
#endif
#endif /* SAUL_REG_H */
/** @} */