diff --git a/bsl/csl/interfaces/pin.h b/bsl/csl/interfaces/pin.h index f2b83d5..a163db0 100644 --- a/bsl/csl/interfaces/pin.h +++ b/bsl/csl/interfaces/pin.h @@ -73,38 +73,39 @@ typedef enum veryFast /*!< set pin's speed to **Very Fast** */ }pinSpeed_t; +/*! Enum to enable ordisable pin interrupt */ typedef enum { - disabled, - enabled + disabled, /*!< Interrupt disabled */ + enabled /*!< Interrupt enabled */ }pinInterrupt_t; +/*! Pin configuration typedef struct*/ typedef struct { - pinMode_t md; - pinStage_t st; - pinPullUpDown_t pud; - pinSpeed_t sp; - pinInterrupt_t intr; + pinMode_t md; /*!< Pin mode */ + pinStage_t st; /*!< Pin logic state */ + pinPullUpDown_t pud; /*!< Pin pullup pulldown status */ + pinSpeed_t sp; /*!< Pin busspeed */ + pinInterrupt_t intr; /*!< Pin interrupt enable state */ }pinConfiguration_t; - -typedef enum -{ - notValidMode, - UnvalidAlternate, - OutOfRangeAlternate, - NotValidSpeed, - notValidOut, - OutOfRange, - NotDeclared, - NotReachable, - NoPullUpDown, - NotAnalog, - NotDigital, - Bocked, - AlreadyUsed, - NotGpio +/*! Typedef enum of all possible pin errors */ +typedef enum { + notValidMode, /*!< Mode is either not valid orsupported by **Hardwaware** */ + UnvalidAlternate, /*!< Alternateive mode is unvalid */ + OutOfRangeAlternate, /*!< */ + NotValidSpeed, /*!< The choosen bus speed is not supported */ + notValidOut, /*!< */ + OutOfRange, /*!< */ + NotDeclared, /*!< */ + NotReachable, /*!< */ + NoPullUpDown, /*!< Pull-Up mode is not supported by **HARDWARE"" */ + NotAnalog, /*!< Analog mode is not supported by **HARDWARE** */ + NotDigital, /*!< Digital mode is not supported by **HARDWARE** */ + Blocked, /*!< */ + AlreadyUsed, /*!< */ + NotGpio /*!< This given pin is not a GPIO **HARDWARE** */ }pinErrors_t; /**