drivers/include: fix typos
This commit is contained in:
parent
54b8e01ba3
commit
eeca0e3752
@ -386,7 +386,7 @@ typedef struct {
|
|||||||
* See page 76 in the data sheet.
|
* See page 76 in the data sheet.
|
||||||
*
|
*
|
||||||
* Assuming a 26 MHz crystal the symbol rate of the transceiver is calculated
|
* Assuming a 26 MHz crystal the symbol rate of the transceiver is calculated
|
||||||
* as fallows (in kBaud):
|
* as follows (in kBaud):
|
||||||
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
* uint8_t exponent = mdmcfg4 & 0x0f;
|
* uint8_t exponent = mdmcfg4 & 0x0f;
|
||||||
* int32_t mantissa = mdmcfg3;
|
* int32_t mantissa = mdmcfg3;
|
||||||
|
|||||||
@ -104,7 +104,7 @@ int ds18_trigger(const ds18_t *dev);
|
|||||||
int ds18_read(const ds18_t *dev, int16_t *temperature);
|
int ds18_read(const ds18_t *dev, int16_t *temperature);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief convenience fuction for triggering a conversion and reading the
|
* @brief convenience function for triggering a conversion and reading the
|
||||||
* value
|
* value
|
||||||
*
|
*
|
||||||
* @note This function will block for the conversion time. The current
|
* @note This function will block for the conversion time. The current
|
||||||
|
|||||||
@ -40,7 +40,7 @@ typedef struct {
|
|||||||
spi_t spi; /**< SPI device the enc is connected to*/
|
spi_t spi; /**< SPI device the enc is connected to*/
|
||||||
gpio_t cs; /**< SPI chip select pin */
|
gpio_t cs; /**< SPI chip select pin */
|
||||||
gpio_t int_pin; /**< SPI interrupt pin */
|
gpio_t int_pin; /**< SPI interrupt pin */
|
||||||
uint16_t rx_next_ptr; /**< ptr to next packet whithin devices memory */
|
uint16_t rx_next_ptr; /**< ptr to next packet within devices memory */
|
||||||
} encx24j600_t;
|
} encx24j600_t;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@ -88,7 +88,7 @@ extern "C" {
|
|||||||
#define KW2XRF_OPT_RAWDUMP (NETDEV_IEEE802154_RAW) /**< legacy define */
|
#define KW2XRF_OPT_RAWDUMP (NETDEV_IEEE802154_RAW) /**< legacy define */
|
||||||
#define KW2XRF_OPT_ACK_REQ (NETDEV_IEEE802154_ACK_REQ) /**< legacy define */
|
#define KW2XRF_OPT_ACK_REQ (NETDEV_IEEE802154_ACK_REQ) /**< legacy define */
|
||||||
|
|
||||||
#define KW2XRF_OPT_AUTOCCA (0x0100) /**< CCA befor TX active */
|
#define KW2XRF_OPT_AUTOCCA (0x0100) /**< CCA before TX active */
|
||||||
#define KW2XRF_OPT_PROMISCUOUS (0x0200) /**< promiscuous mode
|
#define KW2XRF_OPT_PROMISCUOUS (0x0200) /**< promiscuous mode
|
||||||
* active */
|
* active */
|
||||||
#define KW2XRF_OPT_PRELOADING (0x0400) /**< preloading enabled */
|
#define KW2XRF_OPT_PRELOADING (0x0400) /**< preloading enabled */
|
||||||
|
|||||||
@ -115,7 +115,7 @@ typedef struct {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Register Addresses
|
* @brief Register Addresses
|
||||||
* @details For more information on the registers and its funtions see the datasheet
|
* @details For more information on the registers and its functions see the datasheet
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
#define LC709203F_REG_CELL_VOLTAGE 0x09 /**< Register Cell Voltage */
|
#define LC709203F_REG_CELL_VOLTAGE 0x09 /**< Register Cell Voltage */
|
||||||
|
|||||||
@ -13,7 +13,7 @@
|
|||||||
* @ingroup drivers_saul
|
* @ingroup drivers_saul
|
||||||
* @brief Driver for the Freescale MAG3110 magnetometer.
|
* @brief Driver for the Freescale MAG3110 magnetometer.
|
||||||
*
|
*
|
||||||
* After initialization and set activ the magnetometer will make measurements
|
* After initialization and set active the magnetometer will make measurements
|
||||||
* at periodic times.
|
* at periodic times.
|
||||||
* The output rate and over sample ratio can be determined by magnetometer
|
* The output rate and over sample ratio can be determined by magnetometer
|
||||||
* initialization.
|
* initialization.
|
||||||
|
|||||||
@ -59,14 +59,14 @@ enum {
|
|||||||
* @brief Available sampling rates
|
* @brief Available sampling rates
|
||||||
*/
|
*/
|
||||||
enum {
|
enum {
|
||||||
MMA8X5X_RATE_800HZ = (0 << 3), /**< 800 Hz Ouput Data Rate in WAKE mode */
|
MMA8X5X_RATE_800HZ = (0 << 3), /**< 800 Hz Output Data Rate in WAKE mode */
|
||||||
MMA8X5X_RATE_400HZ = (1 << 3), /**< 400 Hz Ouput Data Rate in WAKE mode */
|
MMA8X5X_RATE_400HZ = (1 << 3), /**< 400 Hz Output Data Rate in WAKE mode */
|
||||||
MMA8X5X_RATE_200HZ = (2 << 3), /**< 200 Hz Ouput Data Rate in WAKE mode */
|
MMA8X5X_RATE_200HZ = (2 << 3), /**< 200 Hz Output Data Rate in WAKE mode */
|
||||||
MMA8X5X_RATE_100HZ = (3 << 3), /**< 100 Hz Ouput Data Rate in WAKE mode */
|
MMA8X5X_RATE_100HZ = (3 << 3), /**< 100 Hz Output Data Rate in WAKE mode */
|
||||||
MMA8X5X_RATE_50HZ = (4 << 3), /**< 50 Hz Ouput Data Rate in WAKE mode */
|
MMA8X5X_RATE_50HZ = (4 << 3), /**< 50 Hz Output Data Rate in WAKE mode */
|
||||||
MMA8X5X_RATE_1HZ25 = (5 << 3), /**< 12.5 Hz Ouput Data Rate in WAKE mode */
|
MMA8X5X_RATE_1HZ25 = (5 << 3), /**< 12.5 Hz Output Data Rate in WAKE mode */
|
||||||
MMA8X5X_RATE_6HZ25 = (6 << 3), /**< 6.25 Hz Ouput Data Rate in WAKE mode */
|
MMA8X5X_RATE_6HZ25 = (6 << 3), /**< 6.25 Hz Output Data Rate in WAKE mode */
|
||||||
MMA8X5X_RATE_1HZ56 = (7 << 3) /**< 1.56 Hz Ouput Data Rate in WAKE mode */
|
MMA8X5X_RATE_1HZ56 = (7 << 3) /**< 1.56 Hz Output Data Rate in WAKE mode */
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@ -69,7 +69,7 @@
|
|||||||
* - CCW (Counter ClockWise)
|
* - CCW (Counter ClockWise)
|
||||||
* and a brake capability
|
* and a brake capability
|
||||||
*
|
*
|
||||||
* BRAKE LOW is functionnaly the same than BRAKE HIGH but some H-bridge only
|
* BRAKE LOW is functionally the same than BRAKE HIGH but some H-bridge only
|
||||||
* brake on BRAKE HIGH due to hardware.
|
* brake on BRAKE HIGH due to hardware.
|
||||||
* In case of single direction GPIO, there is no BRAKE, PWM duty cycle is set
|
* In case of single direction GPIO, there is no BRAKE, PWM duty cycle is set
|
||||||
* to 0.
|
* to 0.
|
||||||
|
|||||||
@ -180,7 +180,7 @@ int mtd_read(mtd_dev_t *mtd, void *dest, uint32_t addr, uint32_t count);
|
|||||||
* @brief Write data to a MTD device
|
* @brief Write data to a MTD device
|
||||||
*
|
*
|
||||||
* @p addr + @p count must be inside a page boundary. @p addr can be anywhere
|
* @p addr + @p count must be inside a page boundary. @p addr can be anywhere
|
||||||
* but the buffer cannot overlap two pages. Though some devices might enforce alignement
|
* but the buffer cannot overlap two pages. Though some devices might enforce alignment
|
||||||
* on both @p addr and @p buf.
|
* on both @p addr and @p buf.
|
||||||
*
|
*
|
||||||
* @param mtd the device to write to
|
* @param mtd the device to write to
|
||||||
|
|||||||
@ -335,7 +335,7 @@ int rn2xx3_mac_tx(rn2xx3_t *dev, uint8_t *payload, uint8_t payload_len);
|
|||||||
* @return RN2XX3_ERR_NO_FREE_CH if channels are busy
|
* @return RN2XX3_ERR_NO_FREE_CH if channels are busy
|
||||||
* @return RN2XX3_ERR_SILENT if device is in Silent state
|
* @return RN2XX3_ERR_SILENT if device is in Silent state
|
||||||
* @return RN2XX3_ERR_BUSY if MAC layer is in idle state
|
* @return RN2XX3_ERR_BUSY if MAC layer is in idle state
|
||||||
* @return RN2XX3_ERR_MAC_PAUSED if MAC laid is paused
|
* @return RN2XX3_ERR_MAC_PAUSED if MAC layer is paused
|
||||||
* @return RN2XX3_REPLY_JOIN_ACCEPTED when the join procedure succeeded
|
* @return RN2XX3_REPLY_JOIN_ACCEPTED when the join procedure succeeded
|
||||||
* @return RN2XX3_REPLY_JOIN_DENIED when the join procedure failed
|
* @return RN2XX3_REPLY_JOIN_DENIED when the join procedure failed
|
||||||
*/
|
*/
|
||||||
|
|||||||
@ -114,7 +114,7 @@ enum {
|
|||||||
* @brief Read a value (a set of values) from a device
|
* @brief Read a value (a set of values) from a device
|
||||||
*
|
*
|
||||||
* Simple sensors, as e.g. a temperature sensor, will return exactly one value
|
* Simple sensors, as e.g. a temperature sensor, will return exactly one value
|
||||||
* together with the values scale and unit. Some sensors might return a touple
|
* together with the values scale and unit. Some sensors might return a tuple
|
||||||
* or triple of data (e.g. a 3-axis accelerometer).
|
* or triple of data (e.g. a 3-axis accelerometer).
|
||||||
*
|
*
|
||||||
* Actuators can chose to either just return -ENOTSUP or to return their current
|
* Actuators can chose to either just return -ENOTSUP or to return their current
|
||||||
|
|||||||
@ -254,7 +254,7 @@ int sds011_get_working_period(sds011_t *dev, uint8_t *minutes);
|
|||||||
*
|
*
|
||||||
* @param[in] dev device descriptor
|
* @param[in] dev device descriptor
|
||||||
* @param[in] minutes 0 - 30 new working period of the sensor in minutes
|
* @param[in] minutes 0 - 30 new working period of the sensor in minutes
|
||||||
* 0 for coninuous reporting mode
|
* 0 for continuous reporting mode
|
||||||
* 1 - 30 for a period of @p minutes
|
* 1 - 30 for a period of @p minutes
|
||||||
*
|
*
|
||||||
* @note For values greater than 0, the active duration (fan, laser enabled)
|
* @note For values greater than 0, the active duration (fan, laser enabled)
|
||||||
|
|||||||
@ -68,7 +68,7 @@ typedef struct {
|
|||||||
int si70xx_init(si70xx_t *dev, const si70xx_params_t *params);
|
int si70xx_init(si70xx_t *dev, const si70xx_params_t *params);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Read the relative humidity from the sensor. Uses clock streching.
|
* @brief Read the relative humidity from the sensor. Uses clock stretching.
|
||||||
*
|
*
|
||||||
* @param[in] dev device descriptor
|
* @param[in] dev device descriptor
|
||||||
* @return relative humidity in centi-percent (times 100)
|
* @return relative humidity in centi-percent (times 100)
|
||||||
@ -76,7 +76,7 @@ int si70xx_init(si70xx_t *dev, const si70xx_params_t *params);
|
|||||||
uint16_t si70xx_get_relative_humidity(const si70xx_t *dev);
|
uint16_t si70xx_get_relative_humidity(const si70xx_t *dev);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Read the current temperature from the sensor. Uses clock streching.
|
* @brief Read the current temperature from the sensor. Uses clock stretching.
|
||||||
*
|
*
|
||||||
* @param[in] dev device descriptor
|
* @param[in] dev device descriptor
|
||||||
* @return current temperature in centi-degrees Celsius
|
* @return current temperature in centi-degrees Celsius
|
||||||
|
|||||||
@ -24,7 +24,7 @@
|
|||||||
* synchronous or asynchronous manner. For synchronous operation, the application
|
* synchronous or asynchronous manner. For synchronous operation, the application
|
||||||
* can call tsl4531x_simple_read, and the driver will block for the integration
|
* can call tsl4531x_simple_read, and the driver will block for the integration
|
||||||
* time defined in the initialization parameters (plus a small margin, to encompass
|
* time defined in the initialization parameters (plus a small margin, to encompass
|
||||||
* the max times indicated in the datasheet). For asyncronous operation, the
|
* the max times indicated in the datasheet). For asynchronous operation, the
|
||||||
* application needs to use the functions tsl4531x_start_sample,
|
* application needs to use the functions tsl4531x_start_sample,
|
||||||
* tsl4531x_time_until_sample_ready and tsl4531x_get_sample, as described in those
|
* tsl4531x_time_until_sample_ready and tsl4531x_get_sample, as described in those
|
||||||
* functions' descriptions.
|
* functions' descriptions.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user