Diff: include/d7a.h

Revision:

53:3e4aa4b57090

Parent:

50:30440c9aeb7c

Child:

54:540b327bfa14

diff -r c7a58fc48bd2 -r 3e4aa4b57090 include/d7a.h
--- a/include/d7a.h	Tue Sep 06 15:23:39 2016 +0000
+++ b/include/d7a.h	Tue Sep 06 15:42:42 2016 +0000
@@ -251,7 +251,7 @@
 // =======================================================================
 typedef union
 {
-    // bit access fields
+    /// bit access fields
     struct {
         /// Network security method
         uint8_t nls      : 4;
@@ -262,7 +262,7 @@
         uint8_t rfu_7    : 1;
     } bf;
 
-    // byte access
+    /// byte access
     uint8_t byte;
 
 } d7a_addressee_ctrl_t;
@@ -274,7 +274,7 @@
 // =======================================================================
 typedef union
 {
-    // bit access fields
+    /// bit access fields
     struct {
         /// Subclass mask
         uint8_t m    : 4;
@@ -282,7 +282,7 @@
         uint8_t s    : 4;
     } bf;
 
-    // byte access
+    /// byte access
     uint8_t byte;
 
 } d7a_xcl_t;
@@ -309,9 +309,9 @@
 // d7a_open
 //----------------------------------------------------------------------
 /// @brief                      Open D7A driver and start the modem
-/// @param d7a_com_config_t*    Com port configuration structure
-/// @param PinName              Reset pin
-/// @param d7a_fs_callbacks_t*  File system callbacks (You cannot use local files if this is not specified)
+/// @param com_config           Com port configuration structure
+/// @param reset_pin            Reset pin
+/// @param callbacks            File system callbacks (You cannot use local files if this is not specified)
 /// @return d7a_errors_t        Error code
 //======================================================================
 d7a_errors_t d7a_open(const d7a_com_config_t* com_config, PinName reset_pin, const d7a_callbacks_t* callbacks);
@@ -344,12 +344,13 @@
 // d7a_create
 //----------------------------------------------------------------------
 /// @brief                      Creates a file on the modem
-/// @param d7a_fs_storage_t     Type of file
-/// @param uint8_t              Access permissions
-/// @param uint32_t             Length of the created file
-/// @param uint32_t             Maximum size of the file
-/// @param uint8_t              File ID to an eventual Action file
-/// @param uint8_t              File ID to an eventual Interface file
+/// @param file_id              ID of the file to create
+/// @param prop                 Type of file
+/// @param perm                 Access permissions
+/// @param size                 Length of the created file
+/// @param alloc                Maximum size of the file
+/// @param action_file          File ID to an eventual Action file
+/// @param interface            File ID to an eventual Interface file
 /// @return d7a_errors_t        Error code
 //======================================================================
 d7a_errors_t d7a_create(const uint8_t file_id, d7a_fs_storage_t prop, d7a_fs_perm_t perm, uint32_t size, uint32_t alloc, uint8_t action_file = 0, uint8_t interface = 0);
@@ -358,13 +359,13 @@
 // d7a_declare
 //----------------------------------------------------------------------
 /// @brief                      Declare a file stored on the host to the modem (need to have implemented the fs_callbacks)
-/// @param uint8_t              File ID of file to declare
-/// @param d7a_fs_storage_t     Type of file
-/// @param uint8_t              Access permissions
-/// @param uint32_t             Length of the created file
-/// @param uint32_t             Maximum size of the file
-/// @param uint8_t              File ID to an eventual Action file
-/// @param uint8_t              File ID to an eventual Interface file
+/// @param file_id              ID of the file to declare
+/// @param prop                 Type of file
+/// @param perm                 Access permissions
+/// @param size                 Length of the created file
+/// @param alloc                Maximum size of the file
+/// @param action_file          File ID to an eventual Action file
+/// @param interface            File ID to an eventual Interface file
 /// @return d7a_errors_t        Error code
 //======================================================================
 d7a_errors_t d7a_declare(const uint8_t file_id, d7a_fs_storage_t prop, d7a_fs_perm_t perm, uint32_t size, uint32_t alloc, uint8_t action_file = 0, uint8_t interface = 0);
@@ -373,12 +374,12 @@
 // d7a_read
 //----------------------------------------------------------------------
 /// @brief                      Read data from a file
-/// @param uint8_t              File ID of file to read
-/// @param uint32_t             Offset from which to start reading
-/// @param uint32_t             Size of data to read
-/// @param uint8_t*             Buffer to retrieve data
-/// @param d7a_addressee_t*     Addressee to an eventual distant device
-/// @param alp_rpol_t           Index to the retry policy to use
+/// @param file_id              File ID of file to read
+/// @param offset               Offset from which to start reading
+/// @param size                 Size of data to read
+/// @param buf                  Buffer to retrieve data
+/// @param addressee            Addressee to an eventual distant device
+/// @param retry                Index to the retry policy to use
 /// @return d7a_errors_t        Error code
 //======================================================================
 d7a_errors_t d7a_read(const uint8_t file_id, const uint32_t offset, const uint32_t size, const uint8_t* buf, d7a_addressee_t* addressee = NULL, alp_rpol_t retry = ALP_RPOL_ONESHOT);
@@ -387,12 +388,13 @@
 // d7a_write
 //----------------------------------------------------------------------
 /// @brief                      Write data to a file
-/// @param uint8_t              File ID of file to write
-/// @param uint32_t             Offset from which to start writing
-/// @param uint32_t             Size of data to write
-/// @param uint8_t*             Buffer of the data to write
-/// @param d7a_addressee_t*     Addressee to an eventual distant device
-/// @param alp_rpol_t           Index to the retry policy to use
+/// @param file_id              File ID of file to write
+/// @param offset               Offset from which to start reading
+/// @param size                 Size of data to read
+/// @param buf                  Buffer to retrieve data
+/// @param addressee            Addressee to an eventual distant device
+/// @param retry                Index to the retry policy to use
+/// @param resp                 Wait to see if write is OK
 /// @return d7a_errors_t        Error code
 //======================================================================
 d7a_errors_t d7a_write(const uint8_t file_id, const uint32_t offset, const uint32_t size, const uint8_t* const buf, d7a_addressee_t* addressee = NULL, alp_rpol_t retry = ALP_RPOL_ONESHOT, bool resp = true);
@@ -401,23 +403,14 @@
 // d7a_notify
 //----------------------------------------------------------------------
 /// @brief                      Write data to a file
-/// @param uint8_t              File ID of file to write
-/// @param uint32_t             Offset from which to start writing
-/// @param uint32_t             Size of data to write
+/// @param file_id              File ID of file to write
+/// @param offset               Offset from which to start writing
+/// @param size                 Size of data to write
 /// @return d7a_errors_t        Error code
 //======================================================================
 d7a_errors_t d7a_notify(const uint8_t file_id, const uint32_t offset, const uint32_t size);
 
 
-
-
-
-
-
-
-
-
-
 //======================================================================
 // d7a_modem_print_infos
 //----------------------------------------------------------------------