ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added const modifiers to device mode class drivers.

Browse source 
Added parameter directions to function parameter documentation.

Added new experimental FAST_STREAM_FUNCTIONS compile time option to speed up stream transfers at the expense of a higher FLASH consumption (needs testing to verify improved throughput).
This commit is contained in:
Dean Camera 2009-06-28 13:39:08 +00:00
parent 3cbdcd3686
commit f1076ac4d6
115 changed files with 1031 additions and 633 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Projects/Magstripe/Lib/CircularBitBuffer.h
View file

@ -73,20 +73,20 @@
/* Function Prototypes: */
/** Initializes or resets a given bit buffer, ready to store new bits.
*
* \param Buffer Bit buffer to initialize
* \param[in,out] Buffer Bit buffer to initialize
*/
void BitBuffer_Init(BitBuffer_t* Buffer) ATTR_NON_NULL_PTR_ARG(1);
/** Stores a bit into the next location inside a given bit buffer.
*
* \param Buffer Bit buffer to store a bit into
* \param Bit Bit to store into the buffer
* \param[in,out] Buffer Bit buffer to store a bit into
* \param[in] Bit Bit to store into the buffer
*/
void BitBuffer_StoreNextBit(BitBuffer_t* Buffer, bool Bit) ATTR_NON_NULL_PTR_ARG(1);
/** Retrieves a bit from the next location inside a given bit buffer.
*
* \param Buffer Bit buffer to store a bit into
* \param[in,out] Buffer Bit buffer to store a bit into
*
* \return Next bit from the buffer
*/

14
Projects/Magstripe/Magstripe.c
View file

@ -160,9 +160,9 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
/** HID Class driver callback function for the creation of a HID report for the host.
*
* \param HIDInterfaceInfo Pointer to the HID interface structure for the HID interface being referenced
* \param ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param ReportData Pointer to the preallocated report buffer where the created report should be stored
* \param[in] HIDInterfaceInfo Pointer to the HID interface structure for the HID interface being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[out] ReportData Pointer to the preallocated report buffer where the created report should be stored
*
* \return Number of bytes in the created report
*/
@ -209,10 +209,10 @@ uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* HIDInte
/** HID Class driver callback function for the processing of a received HID report from the host.
*
* \param HIDInterfaceInfo Pointer to the HID interface structure for the HID interface being referenced
* \param ReportID Report ID of the received report from the host
* \param ReportData Pointer to the report buffer where the received report is stored
* \param ReportSize Size in bytes of the report received from the host
* \param[in] HIDInterfaceInfo Pointer to the HID interface structure for the HID interface being referenced
* \param[in] ReportID Report ID of the received report from the host
* \param[in] ReportData Pointer to the report buffer where the received report is stored
* \param[in] ReportSize Size in bytes of the report received from the host
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo, uint8_t ReportID,
void* ReportData, uint16_t ReportSize)

12
Projects/MissileLauncher/MissileLauncher.c
View file

@ -154,8 +154,8 @@ void Read_Joystick_Status(void)
/** Lower level send routine, copies report into a larger buffer and sends.
*
* \param Report Report data to send.
* \param ReportSize Report length in bytes.
* \param[in] Report Report data to send.
* \param[in] ReportSize Report length in bytes.
*/
void Send_Command_Report(uint8_t *Report, uint16_t ReportSize)
{
@ -163,9 +163,9 @@ void Send_Command_Report(uint8_t *Report, uint16_t ReportSize)
WriteNextReport(CmdBuffer, ReportSize);
}
/** Send one of the CMD_* command constants listed above.
/** Sends one of the CMD_* command constants to the attached device.
*
* \param Command One of the command constants.
* \param[in] Command One of the command constants.
*/
void Send_Command(uint8_t* Command)
{
@ -248,8 +248,8 @@ void DiscardNextReport(void)
/** Writes a report to the attached device.
*
* \param ReportOUTData Buffer containing the report to send to the device
* \param ReportLength Length of the report to send
* \param[in] ReportOUTData Buffer containing the report to send to the device
* \param[in] ReportLength Length of the report to send
*/
void WriteNextReport(uint8_t* ReportOUTData, uint16_t ReportLength)
{