Skip to content

Commit

Permalink
Add PROGMEM variant data send functions to the CDC host class driver.
Browse files Browse the repository at this point in the history
  • Loading branch information
abcminiuser committed Aug 1, 2015
1 parent 7c9c3d1 commit 0626ac1
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 1 deletion.
3 changes: 2 additions & 1 deletion LUFA/DoxygenPages/ChangeLog.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
* \section Sec_ChangeLogXXXXXX Version XXXXXX
* <b>New:</b>
* - Added support for the Atmel Xplained-MINI series of development kits
* - Added new PROGMEM variant send functions to the CDC class driver (thanks to Stefan Hellermann)
* - Added new PROGMEM variant send functions to the CDC class device driver (thanks to Stefan Hellermann)
* - Added new PROGMEM variant send functions to the CDC class host driver
*
* <b>Changed:</b>
* - Library Applications:
Expand Down
35 changes: 35 additions & 0 deletions LUFA/Drivers/USB/Class/Host/CDCClassHost.c
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,24 @@ uint8_t CDC_Host_SendData(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
return ErrorCode;
}

uint8_t CDC_Host_SendData_P(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
const void* const Buffer,
const uint16_t Length)
{
if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.IsActive))
return PIPE_READYWAIT_DeviceDisconnected;

uint8_t ErrorCode;

Pipe_SelectPipe(CDCInterfaceInfo->Config.DataOUTPipe.Address);

Pipe_Unfreeze();
ErrorCode = Pipe_Write_PStream_LE(Buffer, Length, NULL);
Pipe_Freeze();

return ErrorCode;
}

uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
const char* const String)
{
Expand All @@ -311,6 +329,23 @@ uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
return ErrorCode;
}

uint8_t CDC_Host_SendString_P(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
const char* const String)
{
if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.IsActive))
return PIPE_READYWAIT_DeviceDisconnected;

uint8_t ErrorCode;

Pipe_SelectPipe(CDCInterfaceInfo->Config.DataOUTPipe.Address);

Pipe_Unfreeze();
ErrorCode = Pipe_Write_PStream_LE(String, strlen_P(String), NULL);
Pipe_Freeze();

return ErrorCode;
}

uint8_t CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
const uint8_t Data)
{
Expand Down
34 changes: 34 additions & 0 deletions LUFA/Drivers/USB/Class/Host/CDCClassHost.h
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,24 @@
const void* const Buffer,
const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);

/** Sends a given data buffer from PROGMEM space to the attached USB device, if connected. If a device is not connected when the
* function is called, the string is discarded. Bytes will be queued for transmission to the host until either the pipe
* bank becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to the device. This allows
* for multiple bytes to be packed into a single pipe packet, increasing data throughput.
*
* \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or
* the call will fail.
*
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
* \param[in] Buffer Pointer to a buffer containing the data to send to the device.
* \param[in] Length Length of the data to send to the host.
*
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
*/
uint8_t CDC_Host_SendData_P(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
const void* const Buffer,
const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);

/** Sends a given null-terminated string to the attached USB device, if connected. If a device is not connected when the
* function is called, the string is discarded. Bytes will be queued for transmission to the device until either the pipe
* bank becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to the device. This allows
Expand All @@ -217,6 +235,22 @@
uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
const char* const String) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);

/** Sends a given null terminated string from PROGMEM space to the attached USB device, if connected. If a device is not connected
* when the function is called, the string is discarded. Bytes will be queued for transmission to the device until either
* the pipe bank becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to
* the device. This allows for multiple bytes to be packed into a single pipe packet, increasing data throughput.
*
* \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or
* the call will fail.
*
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
* \param[in] String Pointer to the null terminated string to send to the host.
*
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
*/
uint8_t CDC_Host_SendString_P(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
const char* const String) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);

/** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the
* byte is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
* \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
Expand Down

0 comments on commit 0626ac1

Please sign in to comment.