riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

drivers/ata8520e: add doc on required buffer sizes

Browse Source
This commit is contained in:
Hauke Petersen 2018-01-26 11:45:43 +01:00
parent f1f079fb0e
commit c3ccdc59c5
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
drivers/include/ata8520e.h
View File

@ -166,7 +166,8 @@ void ata8520e_system_reset(const ata8520e_t *dev);
* @brief Return the Atmel version of the device * @brief Return the Atmel version of the device
* *
* @param[in] dev Pointer to device descriptor * @param[in] dev Pointer to device descriptor
* @param[out] version Pointer to the string containing the version * @param[out] version Pointer to the string containing the version,
* must be able to hold 2 characters
*/ */
void ata8520e_read_atmel_version(const ata8520e_t *dev, uint8_t *version); void ata8520e_read_atmel_version(const ata8520e_t *dev, uint8_t *version);
@ -174,8 +175,8 @@ void ata8520e_read_atmel_version(const ata8520e_t *dev, uint8_t *version);
* @brief Return the Atmel version of the device * @brief Return the Atmel version of the device
* *
* @param[in] dev Pointer to device descriptor * @param[in] dev Pointer to device descriptor
* @param[out] version String containing the version. * @param[out] version String containing the version, must be able to
* The version contains 11 characters. * hold 11 characters
*/ */
void ata8520e_read_sigfox_version(const ata8520e_t *dev, char *version); void ata8520e_read_sigfox_version(const ata8520e_t *dev, char *version);
@ -183,7 +184,8 @@ void ata8520e_read_sigfox_version(const ata8520e_t *dev, char *version);
* @brief Return the porting authorization code (PAC) available in the device * @brief Return the porting authorization code (PAC) available in the device
* *
* @param[in] dev Pointer to device descriptor * @param[in] dev Pointer to device descriptor
* @param[out] pac String containing the pac * @param[out] pac String containing the pac, must be able to
* hold 17 characters
*/ */
void ata8520e_read_pac(const ata8520e_t *dev, char *pac); void ata8520e_read_pac(const ata8520e_t *dev, char *pac);
@ -191,7 +193,8 @@ void ata8520e_read_pac(const ata8520e_t *dev, char *pac);
* @brief Return the ID of the device * @brief Return the ID of the device
* *
* @param[in] dev Pointer to device descriptor * @param[in] dev Pointer to device descriptor
* @param[out] id String containing the ID * @param[out] id String containing the ID, must be able to hold
* 9 characters
*/ */
void ata8520e_read_id(const ata8520e_t *dev, char *id); void ata8520e_read_id(const ata8520e_t *dev, char *id);