f51bce3fed
We currently only support building with CCS and SCons is not using.
bsp/rm48x50/HALCoGen/HALCoGen.{hcg,dil} is the HALCoGen project file.
You may need to regenerate the source file as you like, providing that:
1, IRQ is in Dispatch Mode and the table entry is IRQ_Handler. The
channel 5 in enabled and connected to IRQ.
2, RTI driver is enabled and compare3 source is selected to counter1
and the compare3 will generate tick in the period of 10ms. This
value is coresponding with RT_TICK_PER_SECOND in rtconfig.h.
In CCS, you need to create a new CCS project and create link folders
pointing at bsp/rm48x50, libcpu/arm/rm48x50 and src/, include/. Remember
to add the include path to the Build Properties.
353 lines
12 KiB
C
353 lines
12 KiB
C
//*****************************************************************************
|
|
//
|
|
// usbdcdc.h - USBLib support for generic CDC ACM (serial) device.
|
|
//
|
|
// Copyright (c) 2008-2010 Texas Instruments Incorporated. All rights reserved.
|
|
// Software License Agreement
|
|
//
|
|
// Texas Instruments (TI) is supplying this software for use solely and
|
|
// exclusively on TI's microcontroller products. The software is owned by
|
|
// TI and/or its suppliers, and is protected under applicable copyright
|
|
// laws. You may not combine this software with "viral" open-source
|
|
// software in order to form a larger program.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
|
|
// NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
|
|
// NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
// A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
|
|
// CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
|
|
// DAMAGES, FOR ANY REASON WHATSOEVER.
|
|
//
|
|
//
|
|
//*****************************************************************************
|
|
|
|
#ifndef __USBDCDC_H__
|
|
#define __USBDCDC_H__
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// If building with a C++ compiler, make all of the definitions in this header
|
|
// have a C binding.
|
|
//
|
|
//*****************************************************************************
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
//*****************************************************************************
|
|
//
|
|
//! \addtogroup cdc_device_class_api
|
|
//! @{
|
|
//
|
|
//*****************************************************************************
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// PRIVATE
|
|
//
|
|
// The first few sections of this header are private defines that are used by
|
|
// the USB CDC Serial code and are here only to help with the application
|
|
// allocating the correct amount of memory for the CDC Serial device code.
|
|
//
|
|
//*****************************************************************************
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// PRIVATE
|
|
//
|
|
// This enumeration holds the various states that the device can be in during
|
|
// normal operation.
|
|
//
|
|
//*****************************************************************************
|
|
typedef enum
|
|
{
|
|
//
|
|
// Unconfigured.
|
|
//
|
|
CDC_STATE_UNCONFIGURED,
|
|
|
|
//
|
|
// No outstanding transaction remains to be completed.
|
|
//
|
|
CDC_STATE_IDLE,
|
|
|
|
//
|
|
// Waiting on completion of a send or receive transaction.
|
|
//
|
|
CDC_STATE_WAIT_DATA,
|
|
|
|
//
|
|
// Waiting for client to process data.
|
|
//
|
|
CDC_STATE_WAIT_CLIENT
|
|
}
|
|
tCDCState;
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// PRIVATE
|
|
//
|
|
// This structure defines the private instance data and state variables for the
|
|
// CDC Serial device. The memory for this structure is pointed to by the
|
|
// psPrivateCDCSerData field in the tUSBDCDCDevice structure passed on
|
|
// USBDCDCInit().
|
|
//
|
|
//*****************************************************************************
|
|
typedef struct
|
|
{
|
|
uint32 ulUSBBase;
|
|
tDeviceInfo *psDevInfo;
|
|
tConfigDescriptor *psConfDescriptor;
|
|
volatile tCDCState eCDCRxState;
|
|
volatile tCDCState eCDCTxState;
|
|
volatile tCDCState eCDCRequestState;
|
|
volatile tCDCState eCDCInterruptState;
|
|
volatile uint8 ucPendingRequest;
|
|
uint16 usBreakDuration;
|
|
uint16 usControlLineState;
|
|
uint16 usSerialState;
|
|
volatile uint16 usDeferredOpFlags;
|
|
uint16 usLastTxSize;
|
|
tLineCoding sLineCoding;
|
|
volatile tBoolean bRxBlocked;
|
|
volatile tBoolean bControlBlocked;
|
|
volatile tBoolean bConnected;
|
|
uint8 ucControlEndpoint;
|
|
uint8 ucBulkINEndpoint;
|
|
uint8 ucBulkOUTEndpoint;
|
|
uint8 ucInterfaceControl;
|
|
uint8 ucInterfaceData;
|
|
}
|
|
tCDCSerInstance;
|
|
|
|
|
|
#ifndef DEPRECATED
|
|
//*****************************************************************************
|
|
//
|
|
// The number of bytes of workspace required by the CDC device class driver.
|
|
// The client must provide a block of RAM of at least this size in the
|
|
// psPrivateCDCSerData field of the tUSBCDCDevice structure passed on
|
|
// USBDCDCInit().
|
|
//
|
|
// This value is deprecated and should not be used, any new code should just
|
|
// pass in a tUSBCDCDevice structure in the psPrivateCDCSerData field.
|
|
//
|
|
//*****************************************************************************
|
|
#define USB_CDCSER_WORKSPACE_SIZE (sizeof(tCDCSerInstance))
|
|
#endif
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// The following defines are used when working with composite devices.
|
|
//
|
|
//*****************************************************************************
|
|
|
|
//*****************************************************************************
|
|
//
|
|
//! The size of the memory that should be allocated to create a configuration
|
|
//! descriptor for a single instance of the USB Serial CDC Device.
|
|
//! This does not include the configuration descriptor which is automatically
|
|
//! ignored by the composite device class.
|
|
//
|
|
// For reference this is sizeof(g_pIADSerDescriptor) +
|
|
// sizeof(g_pCDCSerCommInterface) + sizeof(g_pCDCSerDataInterface)
|
|
//
|
|
//*****************************************************************************
|
|
#define COMPOSITE_DCDC_SIZE (8 + 35 + 23)
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// CDC-specific events These events are provided to the application in the
|
|
// \e ulMsg parameter of the tUSBCallback function.
|
|
//
|
|
//*****************************************************************************
|
|
|
|
//
|
|
//! The host requests that the device send a BREAK condition on its
|
|
//! serial communication channel. The BREAK should remain active until
|
|
//! a USBD_CDC_EVENT_CLEAR_BREAK event is received.
|
|
//
|
|
#define USBD_CDC_EVENT_SEND_BREAK (USBD_CDC_EVENT_BASE + 0)
|
|
|
|
//
|
|
//! The host requests that the device stop sending a BREAK condition on its
|
|
//! serial communication channel.
|
|
//
|
|
#define USBD_CDC_EVENT_CLEAR_BREAK (USBD_CDC_EVENT_BASE + 1)
|
|
|
|
//
|
|
//! The host requests that the device set the RS232 signaling lines to
|
|
//! a particular state. The ulMsgValue parameter contains the RTS and
|
|
//! DTR control line states as defined in table 51 of the USB CDC class
|
|
//! definition and is a combination of the following values:
|
|
//!
|
|
//! (RTS) USB_CDC_DEACTIVATE_CARRIER or USB_CDC_ACTIVATE_CARRIER
|
|
//! (DTR) USB_CDC_DTE_NOT_PRESENT or USB_CDC_DTE_PRESENT
|
|
//
|
|
#define USBD_CDC_EVENT_SET_CONTROL_LINE_STATE (USBD_CDC_EVENT_BASE + 2)
|
|
|
|
//
|
|
//! The host requests that the device set the RS232 communication
|
|
//! parameters. The pvMsgData parameter points to a tLineCoding structure
|
|
//! defining the required number of bits per character, parity mode,
|
|
//! number of stop bits and the baud rate.
|
|
//
|
|
#define USBD_CDC_EVENT_SET_LINE_CODING (USBD_CDC_EVENT_BASE + 3)
|
|
|
|
//
|
|
//! The host is querying the current RS232 communication parameters. The
|
|
//! pvMsgData parameter points to a tLineCoding structure that the
|
|
//! application must fill with the current settings prior to returning
|
|
//! from the callback.
|
|
//
|
|
#define USBD_CDC_EVENT_GET_LINE_CODING (USBD_CDC_EVENT_BASE + 4)
|
|
|
|
//*****************************************************************************
|
|
//
|
|
//! The structure used by the application to define operating parameters for
|
|
//! the CDC device.
|
|
//
|
|
//*****************************************************************************
|
|
typedef struct
|
|
{
|
|
//
|
|
//! The vendor ID that this device is to present in the device descriptor.
|
|
//
|
|
uint16 usVID;
|
|
|
|
//
|
|
//! The product ID that this device is to present in the device descriptor.
|
|
//
|
|
uint16 usPID;
|
|
|
|
//
|
|
//! The maximum power consumption of the device, expressed in milliamps.
|
|
//
|
|
uint16 usMaxPowermA;
|
|
|
|
//
|
|
//! Indicates whether the device is self- or bus-powered and whether or not
|
|
//! it supports remote wakeup. Valid values are USB_CONF_ATTR_SELF_PWR or
|
|
//! USB_CONF_ATTR_BUS_PWR, optionally ORed with USB_CONF_ATTR_RWAKE.
|
|
//
|
|
uint8 ucPwrAttributes;
|
|
|
|
//
|
|
//! A pointer to the callback function which will be called to notify
|
|
//! the application of all asynchronous control events related to the
|
|
//! operation of the device.
|
|
//
|
|
tUSBCallback pfnControlCallback;
|
|
|
|
//
|
|
//! A client-supplied pointer which will be sent as the first
|
|
//! parameter in all calls made to the control channel callback,
|
|
//! pfnControlCallback.
|
|
//
|
|
void *pvControlCBData;
|
|
|
|
//
|
|
//! A pointer to the callback function which will be called to notify
|
|
//! the application of events related to the device's data receive channel.
|
|
//
|
|
tUSBCallback pfnRxCallback;
|
|
|
|
//
|
|
//! A client-supplied pointer which will be sent as the first
|
|
//! parameter in all calls made to the receive channel callback,
|
|
//! pfnRxCallback.
|
|
//
|
|
void *pvRxCBData;
|
|
|
|
//
|
|
//! A pointer to the callback function which will be called to notify
|
|
//! the application of events related to the device's data transmit
|
|
//! channel.
|
|
//
|
|
tUSBCallback pfnTxCallback;
|
|
|
|
//
|
|
//! A client-supplied pointer which will be sent as the first
|
|
//! parameter in all calls made to the transmit channel callback,
|
|
//! pfnTxCallback.
|
|
//
|
|
void *pvTxCBData;
|
|
|
|
//
|
|
//! A pointer to the string descriptor array for this device. This array
|
|
//! must contain the following string descriptor pointers in this order.
|
|
//! Language descriptor, Manufacturer name string (language 1), Product
|
|
//! name string (language 1), Serial number string (language 1),
|
|
//! Control interface description string (language 1), Configuration
|
|
//! description string (language 1).
|
|
//!
|
|
//! If supporting more than 1 language, the strings for indices 1 through 5
|
|
//! must be repeated for each of the other languages defined in the
|
|
//! language descriptor.
|
|
//
|
|
const uint8 * const *ppStringDescriptors;
|
|
|
|
//
|
|
//! The number of descriptors provided in the ppStringDescriptors
|
|
//! array. This must be 1 + (5 * number of supported languages).
|
|
//
|
|
uint32 ulNumStringDescriptors;
|
|
|
|
//
|
|
//! A pointer to the private instance data for this device. This memory
|
|
//! must remain accessible for as long as the CDC device is in use and must
|
|
//! not be modified by any code outside the CDC class driver.
|
|
//
|
|
tCDCSerInstance *psPrivateCDCSerData;
|
|
}
|
|
tUSBDCDCDevice;
|
|
|
|
extern tDeviceInfo g_sCDCSerDeviceInfo;
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// API Function Prototypes
|
|
//
|
|
//*****************************************************************************
|
|
extern void * USBDCDCCompositeInit(uint32 ulIndex,
|
|
const tUSBDCDCDevice *psCDCDevice);
|
|
extern void *USBDCDCInit(uint32 ulIndex,
|
|
const tUSBDCDCDevice *psCDCDevice);
|
|
extern void USBDCDCTerm(void *pvInstance);
|
|
extern void *USBDCDCSetControlCBData(void *pvInstance, void *pvCBData);
|
|
extern void *USBDCDCSetRxCBData(void *pvInstance, void *pvCBData);
|
|
extern void *USBDCDCSetTxCBData(void *pvInstance, void *pvCBData);
|
|
extern uint32 USBDCDCPacketWrite(void *pvInstance,
|
|
uint8 *pcData,
|
|
uint32 ulLength,
|
|
tBoolean bLast);
|
|
extern uint32 USBDCDCPacketRead(void *pvInstance,
|
|
uint8 *pcData,
|
|
uint32 ulLength,
|
|
tBoolean bLast);
|
|
extern uint32 USBDCDCTxPacketAvailable(void *pvInstance);
|
|
extern uint32 USBDCDCRxPacketAvailable(void *pvInstance);
|
|
extern void USBDCDCSerialStateChange(void *pvInstance,
|
|
uint16 usState);
|
|
extern void USBDCDCPowerStatusSet(void *pvInstance, uint8 ucPower);
|
|
extern tBoolean USBDCDCRemoteWakeupRequest(void *pvInstance);
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// Close the Doxygen group.
|
|
//! @}
|
|
//
|
|
//*****************************************************************************
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// Mark the end of the C bindings section for C++ compilers.
|
|
//
|
|
//*****************************************************************************
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // __USBDCDC_H__
|