Peripheral Control functions

PCDEx control functions. More...

Functions
HAL_StatusTypeDef	HAL_PCDEx_SetTxFiFo (PCD_HandleTypeDef *hpcd, uint8_t fifo, uint16_t size)
	Set Tx FIFO. More...
HAL_StatusTypeDef	HAL_PCDEx_SetRxFiFo (PCD_HandleTypeDef *hpcd, uint16_t size)
	Set Rx FIFO. More...
HAL_StatusTypeDef	HAL_PCDEx_PMAConfig (PCD_HandleTypeDef *hpcd, uint16_t ep_addr, uint16_t ep_kind, uint32_t pmaadress)
	Configure PMA for EP. More...
HAL_StatusTypeDef	HAL_PCDEx_ActivateLPM (PCD_HandleTypeDef *hpcd)
	Activate LPM feature. More...
HAL_StatusTypeDef	HAL_PCDEx_DeActivateLPM (PCD_HandleTypeDef *hpcd)
	Deactivate LPM feature. More...
HAL_StatusTypeDef	HAL_PCDEx_ActivateBCD (PCD_HandleTypeDef *hpcd)
	Activate BatteryCharging feature. More...
HAL_StatusTypeDef	HAL_PCDEx_DeActivateBCD (PCD_HandleTypeDef *hpcd)
	Deactivate BatteryCharging feature. More...
void	HAL_PCDEx_BCD_VBUSDetect (PCD_HandleTypeDef *hpcd)
	Handle BatteryCharging Process. More...
void	HAL_PCDEx_LPM_Callback (PCD_HandleTypeDef *hpcd, PCD_LPM_MsgTypeDef msg)
	Send LPM message to user layer callback. More...
void	HAL_PCDEx_BCD_Callback (PCD_HandleTypeDef *hpcd, PCD_BCD_MsgTypeDef msg)
	Send BatteryCharging message to user layer callback. More...

Detailed Description

PCDEx control functions.

 ===============================================================================
                 ##### Extended features functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:
      (+) Update FIFO configuration

Function Documentation

HAL_PCDEx_ActivateBCD()

HAL_StatusTypeDef HAL_PCDEx_ActivateBCD

(

PCD_HandleTypeDef *

hpcd

)

Activate BatteryCharging feature.

Parameters

hpcd	PCD handle

Return values

HAL

status

Definition at line 256 of file stm32l4xx_hal_pcd_ex.c.

{
  USB_OTG_GlobalTypeDef *USBx = hpcd->Instance;

  USBx->GCCFG &= ~(USB_OTG_GCCFG_PDEN);
  USBx->GCCFG &= ~(USB_OTG_GCCFG_SDEN);

  /* Power Down USB tranceiver  */
  USBx->GCCFG &= ~(USB_OTG_GCCFG_PWRDWN);

  /* Enable Battery charging */
  USBx->GCCFG |= USB_OTG_GCCFG_BCDEN;

  hpcd->battery_charging_active = 1U;

  return HAL_OK;
}

HAL_PCDEx_ActivateLPM()

HAL_StatusTypeDef HAL_PCDEx_ActivateLPM

(

PCD_HandleTypeDef *

hpcd

)

Activate LPM feature.

Parameters

hpcd	PCD handle

Return values

HAL

status

Definition at line 125 of file stm32l4xx_hal_pcd_ex.c.

{
  USB_OTG_GlobalTypeDef *USBx = hpcd->Instance;

  hpcd->lpm_active = 1U;
  hpcd->LPM_State = LPM_L0;
  USBx->GINTMSK |= USB_OTG_GINTMSK_LPMINTM;
  USBx->GLPMCFG |= (USB_OTG_GLPMCFG_LPMEN | USB_OTG_GLPMCFG_LPMACK | USB_OTG_GLPMCFG_ENBESL);

  return HAL_OK;
}

HAL_PCDEx_BCD_Callback()

__weak void HAL_PCDEx_BCD_Callback	(	PCD_HandleTypeDef *	hpcd,
		PCD_BCD_MsgTypeDef	msg
	)

Send BatteryCharging message to user layer callback.

Parameters

hpcd	PCD handle
msg	LPM message

Return values

HAL

status

Definition at line 537 of file stm32l4xx_hal_pcd_ex.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hpcd);
  UNUSED(msg);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_PCDEx_BCD_Callback could be implemented in the user file
   */
}

HAL_PCDEx_BCD_VBUSDetect()

void HAL_PCDEx_BCD_VBUSDetect

(

PCD_HandleTypeDef *

hpcd

)

Handle BatteryCharging Process.

Parameters

hpcd	PCD handle

Return values

HAL

status

Definition at line 159 of file stm32l4xx_hal_pcd_ex.c.

{
  USB_OTG_GlobalTypeDef *USBx = hpcd->Instance;
  uint32_t tickstart = HAL_GetTick();

  /* Enable DCD : Data Contact Detect */
  USBx->GCCFG |= USB_OTG_GCCFG_DCDEN;

  /* Wait Detect flag or a timeout is happen*/
  while ((USBx->GCCFG & USB_OTG_GCCFG_DCDET) == 0U)
  {
    /* Check for the Timeout */
    if ((HAL_GetTick() - tickstart) > 1000U)
    {
#if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
      hpcd->BCDCallback(hpcd, PCD_BCD_ERROR);
#else
      HAL_PCDEx_BCD_Callback(hpcd, PCD_BCD_ERROR);
#endif /* USE_HAL_PCD_REGISTER_CALLBACKS */

      return;
    }
  }

  /* Right response got */
  HAL_Delay(200U);

  /* Check Detect flag*/
  if ((USBx->GCCFG & USB_OTG_GCCFG_DCDET) == USB_OTG_GCCFG_DCDET)
  {
#if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
    hpcd->BCDCallback(hpcd, PCD_BCD_CONTACT_DETECTION);
#else
    HAL_PCDEx_BCD_Callback(hpcd, PCD_BCD_CONTACT_DETECTION);
#endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
  }

  /*Primary detection: checks if connected to Standard Downstream Port
  (without charging capability) */
  USBx->GCCFG &= ~ USB_OTG_GCCFG_DCDEN;
  HAL_Delay(50U);
  USBx->GCCFG |=  USB_OTG_GCCFG_PDEN;
  HAL_Delay(50U);

  if ((USBx->GCCFG & USB_OTG_GCCFG_PDET) == 0U)
  {
    /* Case of Standard Downstream Port */
#if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
    hpcd->BCDCallback(hpcd, PCD_BCD_STD_DOWNSTREAM_PORT);
#else
    HAL_PCDEx_BCD_Callback(hpcd, PCD_BCD_STD_DOWNSTREAM_PORT);
#endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
  }
  else
  {
    /* start secondary detection to check connection to Charging Downstream
    Port or Dedicated Charging Port */
    USBx->GCCFG &= ~ USB_OTG_GCCFG_PDEN;
    HAL_Delay(50U);
    USBx->GCCFG |=  USB_OTG_GCCFG_SDEN;
    HAL_Delay(50U);

    if ((USBx->GCCFG & USB_OTG_GCCFG_SDET) == USB_OTG_GCCFG_SDET)
    {
      /* case Dedicated Charging Port  */
#if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
      hpcd->BCDCallback(hpcd, PCD_BCD_DEDICATED_CHARGING_PORT);
#else
      HAL_PCDEx_BCD_Callback(hpcd, PCD_BCD_DEDICATED_CHARGING_PORT);
#endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
    }
    else
    {
      /* case Charging Downstream Port  */
#if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
      hpcd->BCDCallback(hpcd, PCD_BCD_CHARGING_DOWNSTREAM_PORT);
#else
      HAL_PCDEx_BCD_Callback(hpcd, PCD_BCD_CHARGING_DOWNSTREAM_PORT);
#endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
    }
  }

  /* Battery Charging capability discovery finished */
  (void)HAL_PCDEx_DeActivateBCD(hpcd);

#if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
  hpcd->BCDCallback(hpcd, PCD_BCD_DISCOVERY_COMPLETED);
#else
  HAL_PCDEx_BCD_Callback(hpcd, PCD_BCD_DISCOVERY_COMPLETED);
#endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
}

HAL_PCDEx_DeActivateBCD()

HAL_StatusTypeDef HAL_PCDEx_DeActivateBCD

(

PCD_HandleTypeDef *

hpcd

)

Deactivate BatteryCharging feature.

Parameters

hpcd	PCD handle

Return values

HAL

status

Definition at line 279 of file stm32l4xx_hal_pcd_ex.c.

{
  USB_OTG_GlobalTypeDef *USBx = hpcd->Instance;

  USBx->GCCFG &= ~(USB_OTG_GCCFG_SDEN);
  USBx->GCCFG &= ~(USB_OTG_GCCFG_PDEN);

  /* Disable Battery charging */
  USBx->GCCFG &= ~(USB_OTG_GCCFG_BCDEN);

  hpcd->battery_charging_active = 0U;

  return HAL_OK;
}

HAL_PCDEx_DeActivateLPM()

HAL_StatusTypeDef HAL_PCDEx_DeActivateLPM

(

PCD_HandleTypeDef *

hpcd

)

Deactivate LPM feature.

Parameters

hpcd	PCD handle

Return values

HAL

status

Definition at line 142 of file stm32l4xx_hal_pcd_ex.c.

{
  USB_OTG_GlobalTypeDef *USBx = hpcd->Instance;

  hpcd->lpm_active = 0U;
  USBx->GINTMSK &= ~USB_OTG_GINTMSK_LPMINTM;
  USBx->GLPMCFG &= ~(USB_OTG_GLPMCFG_LPMEN | USB_OTG_GLPMCFG_LPMACK | USB_OTG_GLPMCFG_ENBESL);

  return HAL_OK;
}

HAL_PCDEx_LPM_Callback()

__weak void HAL_PCDEx_LPM_Callback	(	PCD_HandleTypeDef *	hpcd,
		PCD_LPM_MsgTypeDef	msg
	)

Send LPM message to user layer callback.

Parameters

hpcd	PCD handle
msg	LPM message

Return values

HAL

status

Definition at line 520 of file stm32l4xx_hal_pcd_ex.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hpcd);
  UNUSED(msg);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_PCDEx_LPM_Callback could be implemented in the user file
   */
}

HAL_PCDEx_PMAConfig()

HAL_StatusTypeDef HAL_PCDEx_PMAConfig	(	PCD_HandleTypeDef *	hpcd,
		uint16_t	ep_addr,
		uint16_t	ep_kind,
		uint32_t	pmaadress
	)

Configure PMA for EP.

Parameters

hpcd	Device instance
ep_addr	endpoint address
ep_kind	endpoint Kind USB_SNG_BUF: Single Buffer used USB_DBL_BUF: Double Buffer used
pmaadress	EP address in The PMA: In case of single buffer endpoint this parameter is 16-bit value providing the address in PMA allocated to endpoint. In case of double buffer endpoint this parameter is a 32-bit value providing the endpoint buffer 0 address in the LSB part of 32-bit value and endpoint buffer 1 address in the MSB part of 32-bit value.

Return values

HAL

status

Definition at line 313 of file stm32l4xx_hal_pcd_ex.c.

{
  PCD_EPTypeDef *ep;

  /* initialize ep structure*/
  if ((0x80U & ep_addr) == 0x80U)
  {
    ep = &hpcd->IN_ep[ep_addr & EP_ADDR_MSK];
  }
  else
  {
    ep = &hpcd->OUT_ep[ep_addr];
  }

  /* Here we check if the endpoint is single or double Buffer*/
  if (ep_kind == PCD_SNG_BUF)
  {
    /* Single Buffer */
    ep->doublebuffer = 0U;
    /* Configure the PMA */
    ep->pmaadress = (uint16_t)pmaadress;
  }
  else /* USB_DBL_BUF */
  {
    /* Double Buffer Endpoint */
    ep->doublebuffer = 1U;
    /* Configure the PMA */
    ep->pmaaddr0 = (uint16_t)(pmaadress & 0xFFFFU);
    ep->pmaaddr1 = (uint16_t)((pmaadress & 0xFFFF0000U) >> 16);
  }

  return HAL_OK;
}

HAL_PCDEx_SetRxFiFo()

HAL_StatusTypeDef HAL_PCDEx_SetRxFiFo	(	PCD_HandleTypeDef *	hpcd,
		uint16_t	size
	)

Set Rx FIFO.

Parameters

hpcd	PCD handle
size	Size of Rx fifo

Return values

HAL

status

Definition at line 113 of file stm32l4xx_hal_pcd_ex.c.

{
  hpcd->Instance->GRXFSIZ = size;

  return HAL_OK;
}

HAL_PCDEx_SetTxFiFo()

HAL_StatusTypeDef HAL_PCDEx_SetTxFiFo	(	PCD_HandleTypeDef *	hpcd,
		uint8_t	fifo,
		uint16_t	size
	)

Set Tx FIFO.

Parameters

hpcd	PCD handle
fifo	The number of Tx fifo
size	Fifo size

Return values

HAL

status

Definition at line 71 of file stm32l4xx_hal_pcd_ex.c.

{
  uint8_t i;
  uint32_t Tx_Offset;

  /*  TXn min size = 16 words. (n  : Transmit FIFO index)
      When a TxFIFO is not used, the Configuration should be as follows:
          case 1 :  n > m    and Txn is not used    (n,m  : Transmit FIFO indexes)
         --> Txm can use the space allocated for Txn.
         case2  :  n < m    and Txn is not used    (n,m  : Transmit FIFO indexes)
         --> Txn should be configured with the minimum space of 16 words
     The FIFO is used optimally when used TxFIFOs are allocated in the top
         of the FIFO.Ex: use EP1 and EP2 as IN instead of EP1 and EP3 as IN ones.
     When DMA is used 3n * FIFO locations should be reserved for internal DMA registers */

  Tx_Offset = hpcd->Instance->GRXFSIZ;

  if (fifo == 0U)
  {
    hpcd->Instance->DIEPTXF0_HNPTXFSIZ = ((uint32_t)size << 16) | Tx_Offset;
  }
  else
  {
    Tx_Offset += (hpcd->Instance->DIEPTXF0_HNPTXFSIZ) >> 16;
    for (i = 0U; i < (fifo - 1U); i++)
    {
      Tx_Offset += (hpcd->Instance->DIEPTXF[i] >> 16);
    }

    /* Multiply Tx_Size by 2 to get higher performance */
    hpcd->Instance->DIEPTXF[fifo - 1U] = ((uint32_t)size << 16) | Tx_Offset;
  }

  return HAL_OK;
}