Initialization and de-initialization functions

Initialization and Configuration functions. More...

Modules
	HAL USB OTG HCD Callback ID enumeration definition
	HAL USB OTG HCD Callback ID enumeration definition.
	HAL USB OTG HCD Callback pointer definition
	HAL USB OTG HCD Callback pointer definition.

Functions
HAL_StatusTypeDef	HAL_HCD_Init (HCD_HandleTypeDef *hhcd)
	Initialize the host driver. More...
HAL_StatusTypeDef	HAL_HCD_DeInit (HCD_HandleTypeDef *hhcd)
	DeInitialize the host driver. More...
HAL_StatusTypeDef	HAL_HCD_HC_Init (HCD_HandleTypeDef *hhcd, uint8_t ch_num, uint8_t epnum, uint8_t dev_address, uint8_t speed, uint8_t ep_type, uint16_t mps)
	Initialize a host channel. More...
HAL_StatusTypeDef	HAL_HCD_HC_Halt (HCD_HandleTypeDef *hhcd, uint8_t ch_num)
	Halt a host channel. More...
void	HAL_HCD_MspInit (HCD_HandleTypeDef *hhcd)
	Initialize the HCD MSP. More...
void	HAL_HCD_MspDeInit (HCD_HandleTypeDef *hhcd)
	DeInitialize the HCD MSP. More...
HAL_StatusTypeDef	HAL_HCD_RegisterCallback (HCD_HandleTypeDef *hhcd, HAL_HCD_CallbackIDTypeDef CallbackID, pHCD_CallbackTypeDef pCallback)
	Register a User USB HCD Callback To be used instead of the weak predefined callback. More...
HAL_StatusTypeDef	HAL_HCD_UnRegisterCallback (HCD_HandleTypeDef *hhcd, HAL_HCD_CallbackIDTypeDef CallbackID)
	Unregister an USB HCD Callback USB HCD callabck is redirected to the weak predefined callback. More...
HAL_StatusTypeDef	HAL_HCD_RegisterHC_NotifyURBChangeCallback (HCD_HandleTypeDef *hhcd, pHCD_HC_NotifyURBChangeCallbackTypeDef pCallback)
	Register USB HCD Host Channel Notify URB Change Callback To be used instead of the weak HAL_HCD_HC_NotifyURBChange_Callback() predefined callback. More...
HAL_StatusTypeDef	HAL_HCD_UnRegisterHC_NotifyURBChangeCallback (HCD_HandleTypeDef *hhcd)
	UnRegister the USB HCD Host Channel Notify URB Change Callback USB HCD Host Channel Notify URB Change Callback is redirected to the weak HAL_HCD_HC_NotifyURBChange_Callback() predefined callback. More...

Detailed Description

Initialization and Configuration functions.

 ===============================================================================
          ##### Initialization and de-initialization functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:

Function Documentation

HAL_HCD_DeInit()

HAL_StatusTypeDef HAL_HCD_DeInit

(

HCD_HandleTypeDef *

hhcd

)

DeInitialize the host driver.

Parameters

hhcd	HCD handle

Return values

HAL

status

Definition at line 261 of file stm32l4xx_hal_hcd.c.

{
  /* Check the HCD handle allocation */
  if (hhcd == NULL)
  {
    return HAL_ERROR;
  }

  hhcd->State = HAL_HCD_STATE_BUSY;

#if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
  if (hhcd->MspDeInitCallback == NULL)
  {
    hhcd->MspDeInitCallback = HAL_HCD_MspDeInit; /* Legacy weak MspDeInit  */
  }

  /* DeInit the low level hardware */
  hhcd->MspDeInitCallback(hhcd);
#else
  /* DeInit the low level hardware: CLOCK, NVIC.*/
  HAL_HCD_MspDeInit(hhcd);
#endif /* USE_HAL_HCD_REGISTER_CALLBACKS */

  __HAL_HCD_DISABLE(hhcd);

  hhcd->State = HAL_HCD_STATE_RESET;

  return HAL_OK;
}

HAL_HCD_HC_Halt()

HAL_StatusTypeDef HAL_HCD_HC_Halt	(	HCD_HandleTypeDef *	hhcd,
		uint8_t	ch_num
	)

Halt a host channel.

Parameters

hhcd	HCD handle
ch_num	Channel number. This parameter can be a value from 1 to 15

Return values

HAL

status

Definition at line 245 of file stm32l4xx_hal_hcd.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  __HAL_LOCK(hhcd);
  (void)USB_HC_Halt(hhcd->Instance, (uint8_t)ch_num);
  __HAL_UNLOCK(hhcd);

  return status;
}

HAL_HCD_HC_Init()

HAL_StatusTypeDef HAL_HCD_HC_Init	(	HCD_HandleTypeDef *	hhcd,
		uint8_t	ch_num,
		uint8_t	epnum,
		uint8_t	dev_address,
		uint8_t	speed,
		uint8_t	ep_type,
		uint16_t	mps
	)

Initialize a host channel.

Parameters

hhcd	HCD handle
ch_num	Channel number. This parameter can be a value from 1 to 15
epnum	Endpoint number. This parameter can be a value from 1 to 15
dev_address	Current device address This parameter can be a value from 0 to 255
speed	Current device speed. This parameter can be one of these values: HCD_SPEED_FULL: Full speed mode, HCD_SPEED_LOW: Low speed mode
ep_type	Endpoint Type. This parameter can be one of these values: EP_TYPE_CTRL: Control type, EP_TYPE_ISOC: Isochronous type, EP_TYPE_BULK: Bulk type, EP_TYPE_INTR: Interrupt type
mps	Max Packet Size. This parameter can be a value from 0 to32K

Return values

HAL

status

Definition at line 197 of file stm32l4xx_hal_hcd.c.

{
  HAL_StatusTypeDef status;

  __HAL_LOCK(hhcd);
  hhcd->hc[ch_num].do_ping = 0U;
  hhcd->hc[ch_num].dev_addr = dev_address;
  hhcd->hc[ch_num].max_packet = mps;
  hhcd->hc[ch_num].ch_num = ch_num;
  hhcd->hc[ch_num].ep_type = ep_type;
  hhcd->hc[ch_num].ep_num = epnum & 0x7FU;

  if ((epnum & 0x80U) == 0x80U)
  {
    hhcd->hc[ch_num].ep_is_in = 1U;
  }
  else
  {
    hhcd->hc[ch_num].ep_is_in = 0U;
  }

  hhcd->hc[ch_num].speed = speed;

  status =  USB_HC_Init(hhcd->Instance,
                        ch_num,
                        epnum,
                        dev_address,
                        speed,
                        ep_type,
                        mps);
  __HAL_UNLOCK(hhcd);

  return status;
}

HAL_HCD_Init()

HAL_StatusTypeDef HAL_HCD_Init

(

HCD_HandleTypeDef *

hhcd

)

Initialize the host driver.

Parameters

hhcd	HCD handle

Return values

HAL

status

Definition at line 108 of file stm32l4xx_hal_hcd.c.

{
  USB_OTG_GlobalTypeDef *USBx;

  /* Check the HCD handle allocation */
  if (hhcd == NULL)
  {
    return HAL_ERROR;
  }

  /* Check the parameters */
  assert_param(IS_HCD_ALL_INSTANCE(hhcd->Instance));

  USBx = hhcd->Instance;

  if (hhcd->State == HAL_HCD_STATE_RESET)
  {
    /* Allocate lock resource and initialize it */
    hhcd->Lock = HAL_UNLOCKED;

#if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
    hhcd->SOFCallback = HAL_HCD_SOF_Callback;
    hhcd->ConnectCallback = HAL_HCD_Connect_Callback;
    hhcd->DisconnectCallback = HAL_HCD_Disconnect_Callback;
    hhcd->PortEnabledCallback = HAL_HCD_PortEnabled_Callback;
    hhcd->PortDisabledCallback = HAL_HCD_PortDisabled_Callback;
    hhcd->HC_NotifyURBChangeCallback = HAL_HCD_HC_NotifyURBChange_Callback;

    if (hhcd->MspInitCallback == NULL)
    {
      hhcd->MspInitCallback = HAL_HCD_MspInit;
    }

    /* Init the low level hardware */
    hhcd->MspInitCallback(hhcd);
#else
    /* Init the low level hardware : GPIO, CLOCK, NVIC... */
    HAL_HCD_MspInit(hhcd);
#endif /* (USE_HAL_HCD_REGISTER_CALLBACKS) */
  }

  hhcd->State = HAL_HCD_STATE_BUSY;

  /* Disable DMA mode for FS instance */
  if ((USBx->CID & (0x1U << 8)) == 0U)
  {
    hhcd->Init.dma_enable = 0U;
  }

  /* Disable the Interrupts */
  __HAL_HCD_DISABLE(hhcd);

  /* Init the Core (common init.) */
  (void)USB_CoreInit(hhcd->Instance, hhcd->Init);

  /* Force Host Mode*/
  (void)USB_SetCurrentMode(hhcd->Instance, USB_HOST_MODE);

  /* Init Host */
  (void)USB_HostInit(hhcd->Instance, hhcd->Init);

  hhcd->State = HAL_HCD_STATE_READY;

  return HAL_OK;
}

HAL_HCD_MspDeInit()

__weak void HAL_HCD_MspDeInit

(

HCD_HandleTypeDef *

hhcd

)

DeInitialize the HCD MSP.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 311 of file stm32l4xx_hal_hcd.c.

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

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

HAL_HCD_MspInit()

__weak void HAL_HCD_MspInit

(

HCD_HandleTypeDef *

hhcd

)

Initialize the HCD MSP.

Parameters

hhcd	HCD handle

Return values

None

Definition at line 296 of file stm32l4xx_hal_hcd.c.

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

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

HAL_HCD_RegisterCallback()

HAL_StatusTypeDef HAL_HCD_RegisterCallback	(	HCD_HandleTypeDef *	hhcd,
		HAL_HCD_CallbackIDTypeDef	CallbackID,
		pHCD_CallbackTypeDef	pCallback
	)

Register a User USB HCD Callback To be used instead of the weak predefined callback.

Parameters

hhcd	USB HCD handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_HCD_SOF_CB_ID USB HCD SOF callback ID HAL_HCD_CONNECT_CB_ID USB HCD Connect callback ID HAL_HCD_DISCONNECT_CB_ID OTG HCD Disconnect callback ID HAL_HCD_PORT_ENABLED_CB_ID USB HCD Port Enable callback ID HAL_HCD_PORT_DISABLED_CB_ID USB HCD Port Disable callback ID HAL_HCD_MSPINIT_CB_ID MspDeInit callback ID HAL_HCD_MSPDEINIT_CB_ID MspDeInit callback ID
pCallback	pointer to the Callback function

Return values

HAL

status

Definition at line 719 of file stm32l4xx_hal_hcd.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  if (pCallback == NULL)
  {
    /* Update the error code */
    hhcd->ErrorCode |= HAL_HCD_ERROR_INVALID_CALLBACK;
    return HAL_ERROR;
  }
  /* Process locked */
  __HAL_LOCK(hhcd);

  if (hhcd->State == HAL_HCD_STATE_READY)
  {
    switch (CallbackID)
    {
      case HAL_HCD_SOF_CB_ID :
        hhcd->SOFCallback = pCallback;
        break;

      case HAL_HCD_CONNECT_CB_ID :
        hhcd->ConnectCallback = pCallback;
        break;

      case HAL_HCD_DISCONNECT_CB_ID :
        hhcd->DisconnectCallback = pCallback;
        break;

      case HAL_HCD_PORT_ENABLED_CB_ID :
        hhcd->PortEnabledCallback = pCallback;
        break;

      case HAL_HCD_PORT_DISABLED_CB_ID :
        hhcd->PortDisabledCallback = pCallback;
        break;

      case HAL_HCD_MSPINIT_CB_ID :
        hhcd->MspInitCallback = pCallback;
        break;

      case HAL_HCD_MSPDEINIT_CB_ID :
        hhcd->MspDeInitCallback = pCallback;
        break;

      default :
        /* Update the error code */
        hhcd->ErrorCode |= HAL_HCD_ERROR_INVALID_CALLBACK;
        /* Return error status */
        status =  HAL_ERROR;
        break;
    }
  }
  else if (hhcd->State == HAL_HCD_STATE_RESET)
  {
    switch (CallbackID)
    {
      case HAL_HCD_MSPINIT_CB_ID :
        hhcd->MspInitCallback = pCallback;
        break;

      case HAL_HCD_MSPDEINIT_CB_ID :
        hhcd->MspDeInitCallback = pCallback;
        break;

      default :
        /* Update the error code */
        hhcd->ErrorCode |= HAL_HCD_ERROR_INVALID_CALLBACK;
        /* Return error status */
        status =  HAL_ERROR;
        break;
    }
  }
  else
  {
    /* Update the error code */
    hhcd->ErrorCode |= HAL_HCD_ERROR_INVALID_CALLBACK;
    /* Return error status */
    status =  HAL_ERROR;
  }

  /* Release Lock */
  __HAL_UNLOCK(hhcd);
  return status;
}

HAL_HCD_RegisterHC_NotifyURBChangeCallback()

HAL_StatusTypeDef HAL_HCD_RegisterHC_NotifyURBChangeCallback	(	HCD_HandleTypeDef *	hhcd,
		pHCD_HC_NotifyURBChangeCallbackTypeDef	pCallback
	)

Register USB HCD Host Channel Notify URB Change Callback To be used instead of the weak HAL_HCD_HC_NotifyURBChange_Callback() predefined callback.

Parameters

hhcd	HCD handle
pCallback	pointer to the USB HCD Host Channel Notify URB Change Callback function

Return values

HAL

status

Definition at line 911 of file stm32l4xx_hal_hcd.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  if (pCallback == NULL)
  {
    /* Update the error code */
    hhcd->ErrorCode |= HAL_HCD_ERROR_INVALID_CALLBACK;

    return HAL_ERROR;
  }

  /* Process locked */
  __HAL_LOCK(hhcd);

  if (hhcd->State == HAL_HCD_STATE_READY)
  {
    hhcd->HC_NotifyURBChangeCallback = pCallback;
  }
  else
  {
    /* Update the error code */
    hhcd->ErrorCode |= HAL_HCD_ERROR_INVALID_CALLBACK;

    /* Return error status */
    status =  HAL_ERROR;
  }

  /* Release Lock */
  __HAL_UNLOCK(hhcd);

  return status;
}

HAL_HCD_UnRegisterCallback()

HAL_StatusTypeDef HAL_HCD_UnRegisterCallback	(	HCD_HandleTypeDef *	hhcd,
		HAL_HCD_CallbackIDTypeDef	CallbackID
	)

Unregister an USB HCD Callback USB HCD callabck is redirected to the weak predefined callback.

Parameters

hhcd

USB HCD handle

CallbackID

ID of the callback to be unregistered This parameter can be one of the following values: HAL_HCD_SOF_CB_ID USB HCD SOF callback ID HAL_HCD_CONNECT_CB_ID USB HCD Connect callback ID HAL_HCD_DISCONNECT_CB_ID OTG HCD Disconnect callback ID HAL_HCD_PORT_ENABLED_CB_ID USB HCD Port Enabled callback ID HAL_HCD_PORT_DISABLED_CB_ID USB HCD Port Disabled callback ID HAL_HCD_MSPINIT_CB_ID MspDeInit callback ID HAL_HCD_MSPDEINIT_CB_ID MspDeInit callback ID

Return values

HAL

status

Definition at line 820 of file stm32l4xx_hal_hcd.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  /* Process locked */
  __HAL_LOCK(hhcd);

  /* Setup Legacy weak Callbacks  */
  if (hhcd->State == HAL_HCD_STATE_READY)
  {
    switch (CallbackID)
    {
      case HAL_HCD_SOF_CB_ID :
        hhcd->SOFCallback = HAL_HCD_SOF_Callback;
        break;

      case HAL_HCD_CONNECT_CB_ID :
        hhcd->ConnectCallback = HAL_HCD_Connect_Callback;
        break;

      case HAL_HCD_DISCONNECT_CB_ID :
        hhcd->DisconnectCallback = HAL_HCD_Disconnect_Callback;
        break;

      case HAL_HCD_PORT_ENABLED_CB_ID :
        hhcd->PortEnabledCallback = HAL_HCD_PortEnabled_Callback;
        break;

      case HAL_HCD_PORT_DISABLED_CB_ID :
        hhcd->PortDisabledCallback = HAL_HCD_PortDisabled_Callback;
        break;

      case HAL_HCD_MSPINIT_CB_ID :
        hhcd->MspInitCallback = HAL_HCD_MspInit;
        break;

      case HAL_HCD_MSPDEINIT_CB_ID :
        hhcd->MspDeInitCallback = HAL_HCD_MspDeInit;
        break;

      default :
        /* Update the error code */
        hhcd->ErrorCode |= HAL_HCD_ERROR_INVALID_CALLBACK;

        /* Return error status */
        status =  HAL_ERROR;
        break;
    }
  }
  else if (hhcd->State == HAL_HCD_STATE_RESET)
  {
    switch (CallbackID)
    {
      case HAL_HCD_MSPINIT_CB_ID :
        hhcd->MspInitCallback = HAL_HCD_MspInit;
        break;

      case HAL_HCD_MSPDEINIT_CB_ID :
        hhcd->MspDeInitCallback = HAL_HCD_MspDeInit;
        break;

      default :
        /* Update the error code */
        hhcd->ErrorCode |= HAL_HCD_ERROR_INVALID_CALLBACK;

        /* Return error status */
        status =  HAL_ERROR;
        break;
    }
  }
  else
  {
    /* Update the error code */
    hhcd->ErrorCode |= HAL_HCD_ERROR_INVALID_CALLBACK;

    /* Return error status */
    status =  HAL_ERROR;
  }

  /* Release Lock */
  __HAL_UNLOCK(hhcd);
  return status;
}

HAL_HCD_UnRegisterHC_NotifyURBChangeCallback()

HAL_StatusTypeDef HAL_HCD_UnRegisterHC_NotifyURBChangeCallback

(

HCD_HandleTypeDef *

hhcd

)

UnRegister the USB HCD Host Channel Notify URB Change Callback USB HCD Host Channel Notify URB Change Callback is redirected to the weak HAL_HCD_HC_NotifyURBChange_Callback() predefined callback.

Parameters

hhcd	HCD handle

Return values

HAL

status

Definition at line 951 of file stm32l4xx_hal_hcd.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  /* Process locked */
  __HAL_LOCK(hhcd);

  if (hhcd->State == HAL_HCD_STATE_READY)
  {
    hhcd->HC_NotifyURBChangeCallback = HAL_HCD_HC_NotifyURBChange_Callback; /* Legacy weak DataOutStageCallback  */
  }
  else
  {
    /* Update the error code */
    hhcd->ErrorCode |= HAL_HCD_ERROR_INVALID_CALLBACK;

    /* Return error status */
    status =  HAL_ERROR;
  }

  /* Release Lock */
  __HAL_UNLOCK(hhcd);

  return status;
}