change for GEII project NICE (invert cs)
Diff: max7219.h
- Revision:
- 1:90a7cf4e7d26
- Parent:
- 0:798fb343e022
- Child:
- 2:9150a0dc77a3
diff -r 798fb343e022 -r 90a7cf4e7d26 max7219.h --- a/max7219.h Tue Jan 12 23:40:36 2016 +0000 +++ b/max7219.h Tue Jan 26 02:17:20 2016 +0000 @@ -209,20 +209,25 @@ * @details * * On Entry: + * @param[in] config - Structure containing configuration + * data of device * * On Exit: - * @return none + * @return returns 0 on success + * returns -1 if device number is > _num_devices + * returns -2 if device number is 0 **************************************************************/ - int32_t init_device(max7219_configuration_t config, uint8_t device_number); + int32_t init_device(max7219_configuration_t config); /**********************************************************//** * @brief initializes all devices with given config data * - * @details + * @details all devices are configured with given data * * On Entry: - * + * @param[in] config - Structure containing configuration + * data * On Exit: * @return none **************************************************************/ @@ -235,9 +240,12 @@ * @details * * On Entry: + * @param[in] device_number - device to enable * * On Exit: - * @return none + * @return returns 0 on success + * returns -1 if device number is > _num_devices + * returns -2 if device number is 0 **************************************************************/ int32_t enable_device(uint8_t device_number); @@ -261,9 +269,12 @@ * @details * * On Entry: + * @param[in] device_number - device to disable * * On Exit: - * @return none + * @return returns 0 on success, + * returns -1 if device number is > _num_devices + * returns -2 if device number is 0 **************************************************************/ int32_t disable_device(uint8_t device_number); @@ -288,9 +299,16 @@ * @details * * On Entry: + * @param[in] device_number - device to write too + * @param[in] digit - digit to write + * @param[in] data - data to write * * On Exit: - * @return none + * @return returns 0 on success, + * returns -1 if device number is > _num_devices + * returns -2 if device number is 0 + * returns -3 if digit > 8 + * returns -4 if digit < 1 **************************************************************/ int32_t write_digit(uint8_t device_number, uint8_t digit, uint8_t data); @@ -301,9 +319,15 @@ * @details * * On Entry: + * @param[in] device_number - device to write too + * @param[in] digit - digit to clear * * On Exit: - * @return none + * @return returns 0 on success, + * returns -1 if device number is > _num_devices + * returns -2 if device number is 0 + * returns -3 if digit > 8 + * returns -4 if digit < 1 **************************************************************/ int32_t clear_digit(uint8_t device_number, uint8_t digit); @@ -314,9 +338,12 @@ * @details * * On Entry: + * @param[in] device_number - device to write too * * On Exit: - * @return none + * @return returns 0 on success, + * returns -1 if device number is > _num_devices + * returns -2 if device number is 0 **************************************************************/ int32_t device_all_on(uint8_t device_number); @@ -327,9 +354,12 @@ * @details * * On Entry: + * @param[in] device_number - device to write too * * On Exit: - * @return none + * @return returns 0 on success, + * returns -1 if device number is > _num_devices + * returns -2 if device number is 0 **************************************************************/ int32_t device_all_off(uint8_t device_number);