mfulz_github/qmk_firmware
1
0
Fork 1
mirror of https://github.com/mfulz/qmk_firmware.git synced 2025-10-31 13:22:31 +01:00
Code Issues Projects Releases Wiki Activity

Add missing function attributes to the RingBuffer driver to reduce the chances of invalid usage.

Browse Source 
Fix duplicated LED driver functions in the Doxygen documentation.
This commit is contained in:
Dean Camera 2011-07-11 11:16:57 +00:00
parent c029d72b94
commit f152ff26c7
3 changed files with 30 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
LUFA.pnproj
View File

File diff suppressed because one or more lines are too long

14
LUFA/Drivers/Board/LEDs.h
View File

@ -109,12 +109,12 @@
#if (BOARD == BOARD_NONE) #if (BOARD == BOARD_NONE)
static inline void LEDs_Init(void) {}; static inline void LEDs_Init(void) {};
static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) {}; static inline void LEDs_TurnOnLEDs(const uint_reg_t LEDMask) {};
static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) {}; static inline void LEDs_TurnOffLEDs(const uint_reg_t LEDMask) {};
static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) {}; static inline void LEDs_SetAllLEDs(const uint_reg_t LEDMask) {};
static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask) {}; static inline void LEDs_ChangeLEDs(const uint_reg_t LEDMask, const uint_reg_t ActiveMask) {};
static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) {}; static inline void LEDs_ToggleLEDs(const uint_reg_t LEDMask) {};
static inline uint8_t LEDs_GetLEDs(void) { return 0; } static inline uint_reg_t LEDs_GetLEDs(void) { return 0; }
#elif (BOARD == BOARD_USBKEY) #elif (BOARD == BOARD_USBKEY)
#include "AVR8/USBKEY/LEDs.h" #include "AVR8/USBKEY/LEDs.h"
#elif (BOARD == BOARD_STK525) #elif (BOARD == BOARD_STK525)
@ -176,6 +176,7 @@
#endif #endif
/* Preprocessor Checks: */ /* Preprocessor Checks: */
#if !defined(__DOXYGEN__)
#if !defined(LEDS_LED1) #if !defined(LEDS_LED1)
#define LEDS_LED1 0 #define LEDS_LED1 0
#endif #endif
@ -191,6 +192,7 @@
#if !defined(LEDS_LED4) #if !defined(LEDS_LED4)
#define LEDS_LED4 0 #define LEDS_LED4 0
#endif #endif
#endif
/* Pseudo-Functions for Doxygen: */ /* Pseudo-Functions for Doxygen: */
#if defined(__DOXYGEN__) #if defined(__DOXYGEN__)

12
LUFA/Drivers/Misc/RingBuffer.h
View File

@ -126,6 +126,8 @@
* \param[out] DataPtr Pointer to a global array that will hold the data stored into the ring buffer. * \param[out] DataPtr Pointer to a global array that will hold the data stored into the ring buffer.
* \param[out] Size Maximum number of bytes that can be stored in the underlying data array. * \param[out] Size Maximum number of bytes that can be stored in the underlying data array.
*/ */
static inline void RingBuffer_InitBuffer(RingBuffer_t* Buffer, uint8_t* const DataPtr, const uint16_t Size)
ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
static inline void RingBuffer_InitBuffer(RingBuffer_t* Buffer, uint8_t* const DataPtr, const uint16_t Size) static inline void RingBuffer_InitBuffer(RingBuffer_t* Buffer, uint8_t* const DataPtr, const uint16_t Size)
{ {
GCC_FORCE_POINTER_ACCESS(Buffer); GCC_FORCE_POINTER_ACCESS(Buffer);
@ -157,6 +159,7 @@
* *
* \return Number of bytes currently stored in the buffer. * \return Number of bytes currently stored in the buffer.
*/ */
static inline uint16_t RingBuffer_GetCount(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
static inline uint16_t RingBuffer_GetCount(RingBuffer_t* const Buffer) static inline uint16_t RingBuffer_GetCount(RingBuffer_t* const Buffer)
{ {
uint16_t Count; uint16_t Count;
@ -182,6 +185,7 @@
* *
* \return Number of free bytes in the buffer. * \return Number of free bytes in the buffer.
*/ */
static inline uint16_t RingBuffer_GetFreeCount(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
static inline uint16_t RingBuffer_GetFreeCount(RingBuffer_t* const Buffer) static inline uint16_t RingBuffer_GetFreeCount(RingBuffer_t* const Buffer)
{ {
return (Buffer->Size - RingBuffer_GetCount(Buffer)); return (Buffer->Size - RingBuffer_GetCount(Buffer));
@ -199,6 +203,7 @@
* *
* \return Boolean \c true if the buffer contains no free space, false otherwise. * \return Boolean \c true if the buffer contains no free space, false otherwise.
*/ */
static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer) static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer)
{ {
return (RingBuffer_GetCount(Buffer) == 0); return (RingBuffer_GetCount(Buffer) == 0);
@ -212,6 +217,7 @@
* *
* \return Boolean \c true if the buffer contains no free space, false otherwise. * \return Boolean \c true if the buffer contains no free space, false otherwise.
*/ */
static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer) static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer)
{ {
return (RingBuffer_GetCount(Buffer) == Buffer->Size); return (RingBuffer_GetCount(Buffer) == Buffer->Size);
@ -226,8 +232,8 @@
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into. * \param[in,out] Buffer Pointer to a ring buffer structure to insert into.
* \param[in] Data Data element to insert into the buffer. * \param[in] Data Data element to insert into the buffer.
*/ */
static inline void RingBuffer_Insert(RingBuffer_t* Buffer, static inline void RingBuffer_Insert(RingBuffer_t* Buffer, const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
const uint8_t Data) static inline void RingBuffer_Insert(RingBuffer_t* Buffer, const uint8_t Data)
{ {
GCC_FORCE_POINTER_ACCESS(Buffer); GCC_FORCE_POINTER_ACCESS(Buffer);
@ -254,6 +260,7 @@
* *
* \return Next data element stored in the buffer. * \return Next data element stored in the buffer.
*/ */
static inline uint8_t RingBuffer_Remove(RingBuffer_t* Buffer) ATTR_NON_NULL_PTR_ARG(1);
static inline uint8_t RingBuffer_Remove(RingBuffer_t* Buffer) static inline uint8_t RingBuffer_Remove(RingBuffer_t* Buffer)
{ {
GCC_FORCE_POINTER_ACCESS(Buffer); GCC_FORCE_POINTER_ACCESS(Buffer);
@ -279,6 +286,7 @@
* *
* \return Next data element stored in the buffer. * \return Next data element stored in the buffer.
*/ */
static inline uint8_t RingBuffer_Peek(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
static inline uint8_t RingBuffer_Peek(RingBuffer_t* const Buffer) static inline uint8_t RingBuffer_Peek(RingBuffer_t* const Buffer)
{ {
return *Buffer->Out; return *Buffer->Out;