USBD_CORE_Private_Functions

Collaboration diagram for USBD_CORE_Private_Functions:

Functions
USBD_StatusTypeDef	USBD_Init (USBD_HandleTypeDef *pdev, USBD_DescriptorsTypeDef *pdesc, uint8_t id)
	USBD_Init Initializes the device stack and load the class driver. More...
USBD_StatusTypeDef	USBD_DeInit (USBD_HandleTypeDef *pdev)
	USBD_DeInit Re-Initialize th device library. More...
USBD_StatusTypeDef	USBD_RegisterClass (USBD_HandleTypeDef *pdev, USBD_ClassTypeDef *pclass)
	USBD_RegisterClass Link class driver to Device Core. More...
USBD_StatusTypeDef	USBD_Start (USBD_HandleTypeDef *pdev)
	USBD_Start Start the USB Device Core. More...
USBD_StatusTypeDef	USBD_Stop (USBD_HandleTypeDef *pdev)
	USBD_Stop Stop the USB Device Core. More...
USBD_StatusTypeDef	USBD_RunTestMode (USBD_HandleTypeDef *pdev)
	USBD_RunTestMode Launch test mode process. More...
USBD_StatusTypeDef	USBD_SetClassConfig (USBD_HandleTypeDef *pdev, uint8_t cfgidx)
	USBD_SetClassConfig Configure device and start the interface. More...
USBD_StatusTypeDef	USBD_ClrClassConfig (USBD_HandleTypeDef *pdev, uint8_t cfgidx)
	USBD_ClrClassConfig Clear current configuration. More...
USBD_StatusTypeDef	USBD_LL_SetupStage (USBD_HandleTypeDef *pdev, uint8_t *psetup)
	USBD_SetupStage Handle the setup stage. More...
USBD_StatusTypeDef	USBD_LL_DataOutStage (USBD_HandleTypeDef *pdev, uint8_t epnum, uint8_t *pdata)
	USBD_DataOutStage Handle data OUT stage. More...
USBD_StatusTypeDef	USBD_LL_DataInStage (USBD_HandleTypeDef *pdev, uint8_t epnum, uint8_t *pdata)
	USBD_DataInStage Handle data in stage. More...
USBD_StatusTypeDef	USBD_LL_Reset (USBD_HandleTypeDef *pdev)
	USBD_LL_Reset Handle Reset event. More...
USBD_StatusTypeDef	USBD_LL_SetSpeed (USBD_HandleTypeDef *pdev, USBD_SpeedTypeDef speed)
	USBD_LL_Reset Handle Reset event. More...
USBD_StatusTypeDef	USBD_LL_Suspend (USBD_HandleTypeDef *pdev)
	USBD_Suspend Handle Suspend event. More...
USBD_StatusTypeDef	USBD_LL_Resume (USBD_HandleTypeDef *pdev)
	USBD_Resume Handle Resume event. More...
USBD_StatusTypeDef	USBD_LL_SOF (USBD_HandleTypeDef *pdev)
	USBD_SOF Handle SOF event. More...
USBD_StatusTypeDef	USBD_LL_IsoINIncomplete (USBD_HandleTypeDef *pdev, uint8_t epnum)
	USBD_IsoINIncomplete Handle iso in incomplete event. More...
USBD_StatusTypeDef	USBD_LL_IsoOUTIncomplete (USBD_HandleTypeDef *pdev, uint8_t epnum)
	USBD_IsoOUTIncomplete Handle iso out incomplete event. More...
USBD_StatusTypeDef	USBD_LL_DevConnected (USBD_HandleTypeDef *pdev)
	USBD_DevConnected Handle device connection event. More...
USBD_StatusTypeDef	USBD_LL_DevDisconnected (USBD_HandleTypeDef *pdev)
	USBD_DevDisconnected Handle device disconnection event. More...

Detailed Description

Function Documentation

USBD_Init()

USBD_StatusTypeDef USBD_Init	(	USBD_HandleTypeDef *	pdev,
		USBD_DescriptorsTypeDef *	pdesc,
		uint8_t	id
	)

USBD_Init Initializes the device stack and load the class driver.

Parameters

pdev	device instance
pdesc	Descriptor structure address
id	Low level core index

Return values

None

{
  /* Check whether the USB Host handle is valid */
  if(pdev == NULL)
  {
    USBD_ErrLog("Invalid Device handle");
    return USBD_FAIL;
  }
 
  /* Unlink previous class*/
  if(pdev->pClass != NULL)
  {
    pdev->pClass = NULL;
  }
 
  /* Assign USBD Descriptors */
  if(pdesc != NULL)
  {
    pdev->pDesc = pdesc;
  }
 
  /* Set Device initial State */
  pdev->dev_state  = USBD_STATE_DEFAULT;
  pdev->id = id;
  /* Initialize low level driver */
  USBD_LL_Init(pdev);
 
  return USBD_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBD_DeInit()

USBD_StatusTypeDef USBD_DeInit

(

USBD_HandleTypeDef *

pdev

)

USBD_DeInit Re-Initialize th device library.

Parameters

pdev	device instance

Return values

status

status

{
  /* Set Default State */
  pdev->dev_state  = USBD_STATE_DEFAULT;
 
  /* Free Class Resources */
  pdev->pClass->DeInit(pdev, pdev->dev_config);
 
    /* Stop the low level driver  */
  USBD_LL_Stop(pdev);
 
  /* Initialize low level driver */
  USBD_LL_DeInit(pdev);
 
  return USBD_OK;
}

Here is the call graph for this function:

USBD_RegisterClass()

USBD_StatusTypeDef USBD_RegisterClass	(	USBD_HandleTypeDef *	pdev,
		USBD_ClassTypeDef *	pclass
	)

USBD_RegisterClass Link class driver to Device Core.

Parameters

pDevice	: Device Handle
pclass	Class handle

Return values

USBD

Status

{
  USBD_StatusTypeDef   status = USBD_OK;
  if(pclass != 0)
  {
    /* link the class to the USB Device handle */
    pdev->pClass = pclass;
    status = USBD_OK;
  }
  else
  {
    USBD_ErrLog("Invalid Class handle");
    status = USBD_FAIL;
  }
 
  return status;
}

Here is the caller graph for this function:

USBD_Start()

USBD_StatusTypeDef USBD_Start

(

USBD_HandleTypeDef *

pdev

)

USBD_Start Start the USB Device Core.

Parameters

pdev	Device Handle

Return values

USBD

Status

{
 
  /* Start the low level driver  */
  USBD_LL_Start(pdev);
 
  return USBD_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBD_Stop()

USBD_StatusTypeDef USBD_Stop

(

USBD_HandleTypeDef *

pdev

)

USBD_Stop Stop the USB Device Core.

Parameters

pdev	Device Handle

Return values

USBD

Status

{
  /* Free Class Resources */
  pdev->pClass->DeInit(pdev, pdev->dev_config);
 
  /* Stop the low level driver  */
  USBD_LL_Stop(pdev);
 
  return USBD_OK;
}

Here is the call graph for this function:

USBD_RunTestMode()

USBD_StatusTypeDef USBD_RunTestMode

(

USBD_HandleTypeDef *

pdev

)

USBD_RunTestMode Launch test mode process.

Parameters

pdev	device instance

Return values

status

{
  return USBD_OK;
}

Here is the caller graph for this function:

USBD_SetClassConfig()

USBD_StatusTypeDef USBD_SetClassConfig	(	USBD_HandleTypeDef *	pdev,
		uint8_t	cfgidx
	)

USBD_SetClassConfig Configure device and start the interface.

Parameters

pdev	device instance
cfgidx	configuration index

Return values

status

{
  USBD_StatusTypeDef   ret = USBD_FAIL;
 
  if(pdev->pClass != NULL)
  {
    /* Set configuration  and Start the Class*/
    if(pdev->pClass->Init(pdev, cfgidx) == 0)
    {
      ret = USBD_OK;
    }
  }
  return ret;
}

Here is the caller graph for this function:

USBD_ClrClassConfig()

USBD_StatusTypeDef USBD_ClrClassConfig	(	USBD_HandleTypeDef *	pdev,
		uint8_t	cfgidx
	)

USBD_ClrClassConfig Clear current configuration.

Parameters

pdev	device instance
cfgidx	configuration index

Return values

status

USBD_StatusTypeDef

{
  /* Clear configuration  and De-initialize the Class process*/
  pdev->pClass->DeInit(pdev, cfgidx);
  return USBD_OK;
}

Here is the caller graph for this function:

USBD_LL_SetupStage()

USBD_StatusTypeDef USBD_LL_SetupStage	(	USBD_HandleTypeDef *	pdev,
		uint8_t *	psetup
	)

USBD_SetupStage Handle the setup stage.

Parameters

pdev	device instance

Return values

status

{
 
  USBD_ParseSetupRequest(&pdev->request, psetup);
 
  pdev->ep0_state = USBD_EP0_SETUP;
  pdev->ep0_data_len = pdev->request.wLength;
 
  switch (pdev->request.bmRequest & 0x1F)
  {
  case USB_REQ_RECIPIENT_DEVICE:
    USBD_StdDevReq (pdev, &pdev->request);
    break;
 
  case USB_REQ_RECIPIENT_INTERFACE:
    USBD_StdItfReq(pdev, &pdev->request);
    break;
 
  case USB_REQ_RECIPIENT_ENDPOINT:
    USBD_StdEPReq(pdev, &pdev->request);
    break;
 
  default:
    USBD_LL_StallEP(pdev , pdev->request.bmRequest & 0x80);
    break;
  }
  return USBD_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBD_LL_DataOutStage()

USBD_StatusTypeDef USBD_LL_DataOutStage	(	USBD_HandleTypeDef *	pdev,
		uint8_t	epnum,
		uint8_t *	pdata
	)

USBD_DataOutStage Handle data OUT stage.

Parameters

pdev	device instance
epnum	endpoint index

Return values

status

{
  USBD_EndpointTypeDef    *pep;
 
  if(epnum == 0)
  {
    pep = &pdev->ep_out[0];
 
    if ( pdev->ep0_state == USBD_EP0_DATA_OUT)
    {
      if(pep->rem_length > pep->maxpacket)
      {
        pep->rem_length -=  pep->maxpacket;
 
        USBD_CtlContinueRx (pdev,
                            pdata,
                            MIN(pep->rem_length ,pep->maxpacket));
      }
      else
      {
        if((pdev->pClass->EP0_RxReady != NULL)&&
           (pdev->dev_state == USBD_STATE_CONFIGURED))
        {
          pdev->pClass->EP0_RxReady(pdev);
        }
        USBD_CtlSendStatus(pdev);
      }
    }
  }
  else if((pdev->pClass->DataOut != NULL)&&
          (pdev->dev_state == USBD_STATE_CONFIGURED))
  {
    pdev->pClass->DataOut(pdev, epnum);
  }
  return USBD_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBD_LL_DataInStage()

USBD_StatusTypeDef USBD_LL_DataInStage	(	USBD_HandleTypeDef *	pdev,
		uint8_t	epnum,
		uint8_t *	pdata
	)

USBD_DataInStage Handle data in stage.

Parameters

pdev	device instance
epnum	endpoint index

Return values

status

{
  USBD_EndpointTypeDef    *pep;
 
  if(epnum == 0)
  {
    pep = &pdev->ep_in[0];
 
    if ( pdev->ep0_state == USBD_EP0_DATA_IN)
    {
      if(pep->rem_length > pep->maxpacket)
      {
        pep->rem_length -=  pep->maxpacket;
 
        USBD_CtlContinueSendData (pdev,
                                  pdata,
                                  pep->rem_length);
 
        /* Prepare endpoint for premature end of transfer */
        USBD_LL_PrepareReceive (pdev,
                                0,
                                NULL,
                                0);
      }
      else
      { /* last packet is MPS multiple, so send ZLP packet */
        if((pep->total_length % pep->maxpacket == 0) &&
           (pep->total_length >= pep->maxpacket) &&
             (pep->total_length < pdev->ep0_data_len ))
        {
 
          USBD_CtlContinueSendData(pdev , NULL, 0);
          pdev->ep0_data_len = 0;
 
        /* Prepare endpoint for premature end of transfer */
        USBD_LL_PrepareReceive (pdev,
                                0,
                                NULL,
                                0);
        }
        else
        {
          if((pdev->pClass->EP0_TxSent != NULL)&&
             (pdev->dev_state == USBD_STATE_CONFIGURED))
          {
            pdev->pClass->EP0_TxSent(pdev);
          }
          USBD_CtlReceiveStatus(pdev);
        }
      }
    }
    if (pdev->dev_test_mode == 1)
    {
      USBD_RunTestMode(pdev);
      pdev->dev_test_mode = 0;
    }
  }
  else if((pdev->pClass->DataIn != NULL)&&
          (pdev->dev_state == USBD_STATE_CONFIGURED))
  {
    pdev->pClass->DataIn(pdev, epnum);
  }
  return USBD_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBD_LL_Reset()

USBD_StatusTypeDef USBD_LL_Reset

(

USBD_HandleTypeDef *

pdev

)

USBD_LL_Reset Handle Reset event.

Parameters

pdev	device instance

Return values

status

{
  /* Open EP0 OUT */
  USBD_LL_OpenEP(pdev,
              0x00,
              USBD_EP_TYPE_CTRL,
              USB_MAX_EP0_SIZE);
 
  pdev->ep_out[0].maxpacket = USB_MAX_EP0_SIZE;
 
  /* Open EP0 IN */
  USBD_LL_OpenEP(pdev,
              0x80,
              USBD_EP_TYPE_CTRL,
              USB_MAX_EP0_SIZE);
 
  pdev->ep_in[0].maxpacket = USB_MAX_EP0_SIZE;
  /* Upon Reset call user call back */
  pdev->dev_state = USBD_STATE_DEFAULT;
 
  if (pdev->pClassData)
    pdev->pClass->DeInit(pdev, pdev->dev_config);
 
 
  return USBD_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBD_LL_SetSpeed()

USBD_StatusTypeDef USBD_LL_SetSpeed	(	USBD_HandleTypeDef *	pdev,
		USBD_SpeedTypeDef	speed
	)

USBD_LL_Reset Handle Reset event.

Parameters

pdev	device instance

Return values

status

{
  pdev->dev_speed = speed;
  return USBD_OK;
}

Here is the caller graph for this function:

USBD_LL_Suspend()

USBD_StatusTypeDef USBD_LL_Suspend

(

USBD_HandleTypeDef *

pdev

)

USBD_Suspend Handle Suspend event.

Parameters

pdev	device instance

Return values

status

{
  pdev->dev_old_state =  pdev->dev_state;
  pdev->dev_state  = USBD_STATE_SUSPENDED;
  return USBD_OK;
}

Here is the caller graph for this function:

USBD_LL_Resume()

USBD_StatusTypeDef USBD_LL_Resume

(

USBD_HandleTypeDef *

pdev

)

USBD_Resume Handle Resume event.

Parameters

pdev	device instance

Return values

status

{
  pdev->dev_state = pdev->dev_old_state;
  return USBD_OK;
}

Here is the caller graph for this function:

USBD_LL_SOF()

USBD_StatusTypeDef USBD_LL_SOF

(

USBD_HandleTypeDef *

pdev

)

USBD_SOF Handle SOF event.

Parameters

pdev	device instance

Return values

status

{
  if(pdev->dev_state == USBD_STATE_CONFIGURED)
  {
    if(pdev->pClass->SOF != NULL)
    {
      pdev->pClass->SOF(pdev);
    }
  }
  return USBD_OK;
}

Here is the caller graph for this function:

USBD_LL_IsoINIncomplete()

USBD_StatusTypeDef USBD_LL_IsoINIncomplete	(	USBD_HandleTypeDef *	pdev,
		uint8_t	epnum
	)

USBD_IsoINIncomplete Handle iso in incomplete event.

Parameters

pdev	device instance

Return values

status

{
  return USBD_OK;
}

Here is the caller graph for this function:

USBD_LL_IsoOUTIncomplete()

USBD_StatusTypeDef USBD_LL_IsoOUTIncomplete	(	USBD_HandleTypeDef *	pdev,
		uint8_t	epnum
	)

USBD_IsoOUTIncomplete Handle iso out incomplete event.

Parameters

pdev	device instance

Return values

status

{
  return USBD_OK;
}

Here is the caller graph for this function:

USBD_LL_DevConnected()

USBD_StatusTypeDef USBD_LL_DevConnected

(

USBD_HandleTypeDef *

pdev

)

USBD_DevConnected Handle device connection event.

Parameters

pdev	device instance

Return values

status

{
  return USBD_OK;
}

Here is the caller graph for this function:

USBD_LL_DevDisconnected()

USBD_StatusTypeDef USBD_LL_DevDisconnected

(

USBD_HandleTypeDef *

pdev

)

USBD_DevDisconnected Handle device disconnection event.

Parameters

pdev	device instance

Return values

status

{
  /* Free Class Resources */
  pdev->dev_state = USBD_STATE_DEFAULT;
  pdev->pClass->DeInit(pdev, pdev->dev_config);
 
  return USBD_OK;
}

Here is the caller graph for this function: