LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages

CDC class API functions structure.This module exposes functions which interact directly with USB device controller hardware. More...

#include "usbd_cdcuser.h"

Data Fields

uint32_t(* GetMemSize )(USBD_CDC_INIT_PARAM_T *param)
 
ErrorCode_t(* init )(USBD_HANDLE_T hUsb, USBD_CDC_INIT_PARAM_T *param, USBD_HANDLE_T *phCDC)
 
ErrorCode_t(* SendNotification )(USBD_HANDLE_T hCdc, uint8_t bNotification, uint16_t data)
 

Detailed Description

CDC class API functions structure.

This module exposes functions which interact directly with USB device controller hardware.

Definition at line 244 of file usbd_cdcuser.h.

Field Documentation

uint32_t GetMemSize

Function to determine the memory required by the CDC function driver module.

This function is called by application layer before calling pUsbApi->CDC->Init(), to allocate memory used by CDC function driver module. The application should allocate the memory which is accessible by USB controller/DMA controller.

Note
Some memory areas are not accessible by all bus masters.
Parameters
paramStructure containing CDC function driver module initialization parameters.
Returns
Returns the required memory size in bytes.

Definition at line 257 of file usbd_cdcuser.h.

Function to initialize CDC function driver module.

This fuction is called by application layer to initialize CDC function driver module.

Parameters
hUsbHandle to the USB device stack.
paramStructure containing CDC function driver module initialization parameters.
Returns
Returns ErrorCode_t type to indicate success or error condition.
Return values
LPC_OKOn success
ERR_USBD_BAD_MEM_BUFMemory buffer passed is not 4-byte aligned or smaller than required.
ERR_API_INVALID_PARAM2Either CDC_Write() or CDC_Read() or CDC_Verify() callbacks are not defined.
ERR_USBD_BAD_INTF_DESCWrong interface descriptor is passed.
ERR_USBD_BAD_EP_DESCWrong endpoint descriptor is passed.

Definition at line 275 of file usbd_cdcuser.h.

ErrorCode_t SendNotification

Function to initialize CDC function driver module.

This fuction is called by application layer to initialize CDC function driver module.

Parameters
hUsbHandle to the USB device stack.
paramStructure containing CDC function driver module initialization parameters.
Returns
Returns ErrorCode_t type to indicate success or error condition.
Return values
LPC_OKOn success
ERR_USBD_BAD_MEM_BUFMemory buffer passed is not 4-byte aligned or smaller than required.
ERR_API_INVALID_PARAM2Either CDC_Write() or CDC_Read() or CDC_Verify() callbacks are not defined.
ERR_USBD_BAD_INTF_DESCWrong interface descriptor is passed.
ERR_USBD_BAD_EP_DESCWrong endpoint descriptor is passed.

Definition at line 293 of file usbd_cdcuser.h.


The documentation for this struct was generated from the following file: