mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
16f859dafd
This makes life easier when calling e.g. `saul_reg_write()` with data stored in flash. As now the signatures for reading and writing differ (in that `const` qualifier only), `saul_notsup()` is split into `saul_write_notsup()` and `saul_read_notsup()`. However, one is implemented as a symbol alias of the other, so that ROM consumption remains unchanged.
145 lines
3.9 KiB
C
145 lines
3.9 KiB
C
/*
|
|
* 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 Find a device by its 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 by its type in the registry
|
|
*
|
|
* @param[in] type the 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 the first device by its name in the registry
|
|
*
|
|
* @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 Find the first device by its type and name in the registry
|
|
*
|
|
* @param[in] type the device type to look for
|
|
* @param[in] name the name to look for
|
|
*
|
|
* @return pointer to the first device matching the given type and name
|
|
* @return NULL if no device with that type and name could be found
|
|
*/
|
|
saul_reg_t *saul_reg_find_type_and_name(uint8_t type, 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, const phydat_t *data);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* SAUL_REG_H */
|
|
/** @} */
|