Skip to content

Commit

Permalink
drivers/ata8520e: add doc on required buffer sizes
Browse files Browse the repository at this point in the history
  • Loading branch information
haukepetersen committed Jan 30, 2018
1 parent f1f079f commit c3ccdc5
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions drivers/include/ata8520e.h
Expand Up @@ -166,32 +166,35 @@ void ata8520e_system_reset(const ata8520e_t *dev);
* @brief Return the Atmel version of the device
*
* @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);

/**
* @brief Return the Atmel version of the device
*
* @param[in] dev Pointer to device descriptor
* @param[out] version String containing the version.
* The version contains 11 characters.
* @param[out] version String containing the version, must be able to
* hold 11 characters
*/
void ata8520e_read_sigfox_version(const ata8520e_t *dev, char *version);

/**
* @brief Return the porting authorization code (PAC) available in the device
*
* @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);

/**
* @brief Return the ID of the device
*
* @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);

Expand Down

0 comments on commit c3ccdc5

Please sign in to comment.