diff options
Diffstat (limited to 'ctrl/sysrepo-plugins/hicn-plugin/plugin/model/tlock.h')
| -rw-r--r-- | ctrl/sysrepo-plugins/hicn-plugin/plugin/model/tlock.h | 37 |
1 files changed, 35 insertions, 2 deletions
diff --git a/ctrl/sysrepo-plugins/hicn-plugin/plugin/model/tlock.h b/ctrl/sysrepo-plugins/hicn-plugin/plugin/model/tlock.h index 8cdfc8b5b..a871705a3 100644 --- a/ctrl/sysrepo-plugins/hicn-plugin/plugin/model/tlock.h +++ b/ctrl/sysrepo-plugins/hicn-plugin/plugin/model/tlock.h @@ -14,18 +14,51 @@ */ + +/** + * @file tlock.h + * @brief This file contains ticket lock APIs. + */ + #ifndef __TLOCK_H__ #define __TLOCK_H__ -// limit on the number of locks: it shoud be matched with the number of hicn-state leaves +/** + + * @brief limit the number of locks: it shoud be matched with the + * number of hicn-state leaves + */ #define MAX_LOCK_SIZE 5 -volatile long int En[MAX_LOCK_SIZE] , De[MAX_LOCK_SIZE] ; // For Ticket Algorithm +/** + * @brief Ticket lock counters + */ +volatile long int En[MAX_LOCK_SIZE] ; + +/** + * @brief Ticket lock counters + */ +volatile long int De[MAX_LOCK_SIZE] ; +/** + * @brief This function initialize the ticket lock + * @param Lock_Number describes the number of locks need to be initialized + * @param init describes the init number + */ void ticket_init ( int Lock_Number , long int init ); +/** + * @brief this function acquire the lock + * Description of what the function does. This part may refer to the parameters + * @param Lock_Number pass the lock + */ void tlock(int Lock_Number ); +/** + * @briefthis function release the lock + * @param Lock_Number lock number + + */ void tunlock(int Lock_Number ); #endif /* __IETF_HICN_H__ */
\ No newline at end of file |