diff options
Diffstat (limited to 'src/include/eiotas_userbits.h')
| -rw-r--r-- | src/include/eiotas_userbits.h | 53 |
1 files changed, 46 insertions, 7 deletions
diff --git a/src/include/eiotas_userbits.h b/src/include/eiotas_userbits.h index 4e33d1e..e4149b8 100644 --- a/src/include/eiotas_userbits.h +++ b/src/include/eiotas_userbits.h @@ -22,30 +22,69 @@ #include "eiotas_iota.h" #include "eiotas_particle.h" +/** + * @typedef Eiotas_User_Bits + * Type for a Eiotas_User_Bits. + */ typedef struct _Eiotas_User_Bits Eiotas_User_Bits; +/** + * @typedef Eiotas_User_Data + * Struct for user allocated data attached to a Eiotas_Door or a Eiotas_Board + */ typedef void Eiotas_User_Data; +/** + * @typedef Eiotas_User_Data + * Type for function called on resources free + * + * @see eiotas_door_free() + * @see eiotas_board_free() + */ typedef void (*Eiotas_User_Data_Free) (Eiotas_User_Data*); +/** + * @typedef Eiotas_Receive_Particle + * Type for function called on Eiotas_Particle receive + */ typedef void (*Eiotas_Receive_Particle) (Eiotas_Iota *iota, Eiotas_Particle *particle, Eiotas_User_Data *data); +/** + * @typedef Eiotas_Init + * Type for function called on systsem init + */ typedef void (*Eiotas_Init) (Eiotas_Iota *iota, Eiotas_User_Data *data); +/** + * @typedef Eiotas_Shutdown + * Type for function called on system shutdown + */ typedef void (*Eiotas_Shutdown) (Eiotas_Iota *iota, Eiotas_User_Data *data); +/** + * @typedef Eiotas_Suspend + * Type for function called on system suspend + */ typedef void (*Eiotas_Suspend) (Eiotas_Iota *iota, Eiotas_User_Data *data); +/** + * @typedef Eiotas_Resume + * Type for function called on system resume + */ typedef void (*Eiotas_Resume) (Eiotas_Iota *iota, Eiotas_User_Data *data); +/** + * @typedef _Eiotas_User_Bits + * Type for a Eiotas_User_Bits. + */ struct _Eiotas_User_Bits { - Eiotas_User_Data *data; /* user data */ - Eiotas_User_Data_Free free_fct; /* to free user data */ - Eiotas_Receive_Particle recv_fct; /* to receive and process a particle */ - Eiotas_Init init_fct; /* to initialize user data on system init */ - Eiotas_Shutdown shutdown_fct; /* to finalize user data on system shutdown */ - Eiotas_Suspend suspend_fct; /* to serialize user data on system shutdown */ - Eiotas_Resume resume_fct; /* to deserialize data on system resume */ + Eiotas_User_Data *data; /**< user data */ + Eiotas_User_Data_Free free_fct; /**< to free user data */ + Eiotas_Receive_Particle recv_fct; /**< to receive and process a Eiotas_Particle */ + Eiotas_Init init_fct; /**< to initialize user data on system init */ + Eiotas_Shutdown shutdown_fct; /**< to finalize user data on system shutdown */ + Eiotas_Suspend suspend_fct; /**< to serialize user data on system shutdown */ + Eiotas_Resume resume_fct; /**< to deserialize data on system resume */ }; #endif // __EIOTAS_USERBITS_H__ |