STM32CubeF1 HAL Driver

https://github.com/stmicroelectronics/stm32f1xx-hal-driver
Admin
STM32CubeF1 HAL Driver provides Hardware Abstraction Layer and Low-Level drivers for STM32F1...
Tokens:188,748
Snippets:1,087
Trust Score:9.8
License:BSD-3-Clause
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Host-side Channel Submit Example

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/usb.md

Initializes a host channel and submits a control transfer request. The URB completion callback checks for URB_DONE to indicate the setup stage completed.

```c
#include "stm32f1xx_hal_hcd.h"

HCD_HandleTypeDef hhcd;

void host_control_transfer(void)
{
  HAL_HCD_HC_Init(&hhcd, 0U, 0U, 2U, HCD_SPEED_FULL, EP_TYPE_CTRL, 64U);
  HAL_HCD_HC_SubmitRequest(&hhcd, 0U, 0U, EP_TYPE_CTRL, 0U, setup_buf, 8U, HCD_SPEED_FULL);
}

void HAL_HCD_HC_NotifyURBChange_Callback(HCD_HandleTypeDef *hhcd, uint8_t chnum, HCD_URBStateTypeDef urb_state)
{
  if (urb_state == URB_DONE) { /* setup stage completed */ }
}
```

--------------------------------

### HAL_ETH_Start

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/eth.md

Starts the Ethernet DMA (Tx/Rx).

```APIDOC
## HAL_ETH_Start

### Description
Starts the Ethernet DMA for transmission and reception.

### Function Signature
HAL_StatusTypeDef HAL_ETH_Start(ETH_HandleTypeDef *heth)

### Parameters
- **heth** (ETH_HandleTypeDef*) - Required - Pointer to Ethernet handle.

### Returns
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_ERROR on failure.

```

--------------------------------

### HAL_ADCEx_MultiModeStart_DMA

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/adc.md

Starts multi-mode conversions with DMA.

```APIDOC
## HAL_ADCEx_MultiModeStart_DMA

### Description
Starts multi-mode conversions with DMA.

### Function Signature
```c
HAL_StatusTypeDef HAL_ADCEx_MultiModeStart_DMA(ADC_HandleTypeDef *hadc, uint32_t *pData, uint32_t Length);
```

### Parameters
- **hadc** (ADC_HandleTypeDef*) - Pointer to the ADC handle.
- **pData** (uint32_t*) - Pointer to the data buffer for DMA transfer.
- **Length** (uint32_t) - Number of data items to transfer.

### Return Value
- **HAL_StatusTypeDef** - HAL status.
```

--------------------------------

### HAL_PCD_Start

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/usb.md

Starts the USB device and triggers the reset callback.

```APIDOC
## `HAL_PCD_Start`

### Description
Enables the USB device and forces the RESET callback.

### Method
Function call

### Function Signature
`HAL_StatusTypeDef HAL_PCD_Start(PCD_HandleTypeDef *hpcd)`

### Parameters
- `hpcd` (PCD_HandleTypeDef*) - Required - Pointer to the PCD handle structure.

### Returns
- `HAL_StatusTypeDef` - HAL_OK, HAL_ERROR, HAL_BUSY, or HAL_TIMEOUT.
```

--------------------------------

### HAL_ADC_Start

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/adc.md

Enables the ADC and starts software-triggered conversions.

```APIDOC
## HAL_ADC_Start

### Description
Enables the ADC and starts software-triggered conversions.

### Function Signature
`HAL_StatusTypeDef HAL_ADC_Start(ADC_HandleTypeDef* hadc)`

### Parameters
- **hadc** (ADC_HandleTypeDef*) - Required - Pointer to the ADC handle.

### Return Value
- **HAL_StatusTypeDef** - HAL status (HAL_OK, HAL_ERROR, HAL_BUSY, HAL_TIMEOUT).
```

--------------------------------

### HAL_HCD_Start

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/usb.md

Starts the USB host, enabling port power and SOF generation.

```APIDOC
## HAL_HCD_Start

### Description
Starts the USB host, enabling port power and SOF generation.

### Method
Function

### Parameters
- **hhcd** (HCD_HandleTypeDef*) - Required - Pointer to the HCD handle.

### Returns
- **HAL_StatusTypeDef** - Status of the start operation.

```

--------------------------------

### HAL_ETH_Start

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/eth.md

Starts the Ethernet peripheral and enables the DMA transmission and reception.

```APIDOC
## HAL_ETH_Start

### Description
Starts the Ethernet peripheral and enables the DMA transmission and reception.

### Method
HAL_ETH_Start

### Parameters
- **heth** (ETH_HandleTypeDef*) - Pointer to an ETH_HandleTypeDef structure.

### Request Example
```c
if (HAL_ETH_Start(&heth) != HAL_OK) { }
```

### Response
#### Success Response
- **HAL_StatusTypeDef** - HAL_OK on success.
```

--------------------------------

### CAN Initialization and Filter Configuration

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/can.md

Example of initializing the CAN peripheral and configuring a filter for reception.

```APIDOC
## CAN Initialization and Filter Configuration

### Description
Example showing how to initialize the CAN peripheral and configure a filter for reception.

### Functions Used
- HAL_CAN_Init
- HAL_CAN_ConfigFilter
- HAL_CAN_Start

### Example Code
```c
#include "stm32f1xx_hal_can.h"

CAN_HandleTypeDef hcan1;

void can_init(void)
{
  __HAL_RCC_CAN1_CLK_ENABLE();
  hcan1.Instance = CAN1;
  hcan1.Init.Prescaler         = 9U;                       /* e.g. 36 MHz APB1 /9/16 = 250 kbit/s */
  hcan1.Init.Mode              = CAN_MODE_NORMAL;
  hcan1.Init.SyncJumpWidth     = CAN_SJW_1TQ;
  hcan1.Init.TimeSeg1          = CAN_BS1_13TQ;
  hcan1.Init.TimeSeg2          = CAN_BS2_2TQ;
  hcan1.Init.TimeTriggeredMode = DISABLE;
  hcan1.Init.AutoBusOff        = DISABLE;
  hcan1.Init.AutoWakeUp        = DISABLE;
  hcan1.Init.AutoRetransmission = DISABLE;
  hcan1.Init.ReceiveFifoLocked = DISABLE;
  hcan1.Init.TransmitFifoPriority = DISABLE;
  HAL_CAN_Init(&hcan1);

  CAN_FilterTypeDef filter = {0};
  filter.FilterIdHigh         = 0x0000U;
  filter.FilterIdLow          = 0x0000U;
  filter.FilterMaskIdHigh     = 0x0000U;
  filter.FilterMaskIdLow      = 0x0000U;
  filter.FilterFIFOAssignment = CAN_RX_FIFO0;
  filter.FilterBank           = 0U;
  filter.FilterMode           = CAN_FILTERMODE_IDMASK;
  filter.FilterScale          = CAN_FILTERSCALE_32BIT;
  filter.FilterActivation     = ENABLE;
  HAL_CAN_ConfigFilter(&hcan1, &filter);

  if (HAL_CAN_Start(&hcan1) != HAL_OK) { /* could not leave init mode */ }
}
```

```

--------------------------------

### HAL_CAN_Start

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/can.md

Starts the CAN peripheral by leaving initialization mode (INRQ=0). Returns HAL_ERROR if the exit times out.

```APIDOC
## HAL_CAN_Start

### Description
Leaves initialization mode by clearing the INRQ bit. Returns HAL_ERROR if the exit times out.

### Method
Function

### Signature
`HAL_StatusTypeDef HAL_CAN_Start(CAN_HandleTypeDef *hcan)`

### Parameters
- **hcan** (CAN_HandleTypeDef*) - Required - Pointer to the CAN handle.

### Return Value
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_ERROR on failure.
```

--------------------------------

### HAL_IWDG_Init

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/pwr-watchdog.md

Initializes the independent watchdog by writing the unlock key, programming the prescaler and reload registers, and starting the watchdog.

```APIDOC
## HAL_IWDG_Init

### Description
Writes the unlock key (0x5555), programs the prescaler and reload registers, and starts the independent watchdog (key 0xCCCC). Returns HAL_OK on success or HAL_ERROR when registers cannot be updated (e.g., reload value out of range).

### Function Signature
`HAL_StatusTypeDef HAL_IWDG_Init(IWDG_HandleTypeDef *hiwdg)`

### Parameters
- **hiwdg** (IWDG_HandleTypeDef*) - Pointer to an IWDG handle structure containing the Instance and Init fields.

### Return Value
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_ERROR on failure.

### Example
```c
IWDG_HandleTypeDef hiwdg;
hiwdg.Instance = IWDG;
hiwdg.Init.Prescaler = IWDG_PRESCALER_64;
hiwdg.Init.Reload = 625;
HAL_IWDG_Init(&hiwdg);
```
```

--------------------------------

### HAL_MspInit and HAL_MspDeInit prototypes

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/hal.md

Weak no-op defaults for MSP initialization and de-initialization. Overridden by the application for global low-level hardware setup.

```c
void HAL_MspInit(void);
void HAL_MspDeInit(void);
```

--------------------------------

### Single Software-Triggered Conversion with Polling

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/adc.md

Example of initializing the ADC, configuring a channel, and reading a value using polling.

```APIDOC
## Single Software-Triggered Conversion with Polling

### Description
This example demonstrates how to initialize the ADC, configure a channel, and read a conversion result using polling.

### Functions Used
- `HAL_ADC_Init(&hadc1)` - Initializes the ADC peripheral.
- `HAL_ADC_ConfigChannel(&hadc1, &cfg)` - Configures an ADC channel.
- `HAL_ADC_Start(&hadc1)` - Starts ADC conversion.
- `HAL_ADC_PollForConversion(&hadc1, 100U)` - Polls for conversion completion with a timeout.
- `HAL_ADC_GetValue(&hadc1)` - Gets the conversion result.
- `HAL_ADC_Stop(&hadc1)` - Stops ADC conversion.

### Configuration Structure
- `ADC_HandleTypeDef hadc1` - ADC handle.
- `ADC_ChannelConfTypeDef cfg` - Channel configuration.

### Example Code
```c
#include "stm32f1xx_hal_adc.h"

ADC_HandleTypeDef hadc1;

void adc_init(void)
{
  __HAL_RCC_ADC1_CLK_ENABLE();
  hadc1.Instance                   = ADC1;
  hadc1.Init.DataAlign             = ADC_DATAALIGN_RIGHT;
  hadc1.Init.ScanConvMode          = DISABLE;
  hadc1.Init.ContinuousConvMode    = DISABLE;
  hadc1.Init.NbrOfConversion       = 1U;
  hadc1.Init.DiscontinuousConvMode = DISABLE;
  hadc1.Init.ExternalTrigConv      = ADC_SOFTWARE_START;
  HAL_ADC_Init(&hadc1);
}

uint16_t read_channel(uint32_t ch)
{
  ADC_ChannelConfTypeDef cfg = {0};
  cfg.Channel      = ch;
  cfg.Rank         = ADC_REGULAR_RANK_1;
  cfg.SamplingTime = ADC_SAMPLINGTIME_55CYCLES_5;
  HAL_ADC_ConfigChannel(&hadc1, &cfg);

  HAL_ADC_Start(&hadc1);
  if (HAL_ADC_PollForConversion(&hadc1, 100U) != HAL_OK)
  {
    return 0xFFFFU;                     /* timeout */
  }
  uint32_t value = HAL_ADC_GetValue(&hadc1);
  HAL_ADC_Stop(&hadc1);
  return (uint16_t)value;
}
```
```

--------------------------------

### HAL_ADC_Start_IT

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/adc.md

Enables EOC, AWD, and OVR interrupts and starts conversions. Callbacks are invoked on completion, level out of window, or error.

```APIDOC
## HAL_ADC_Start_IT

### Description
Enables EOC, AWD, and OVR interrupts and starts conversions. Callbacks are invoked on completion, level out of window, or error.

### Function Signature
`HAL_StatusTypeDef HAL_ADC_Start_IT(ADC_HandleTypeDef* hadc)`

### Parameters
- **hadc** (ADC_HandleTypeDef*) - Required - Pointer to the ADC handle.

### Return Value
- **HAL_StatusTypeDef** - HAL status (HAL_OK, HAL_ERROR, HAL_BUSY, HAL_TIMEOUT).

### Callbacks
- `HAL_ADC_ConvCpltCallback` - Called on conversion complete.
- `HAL_ADC_LevelOutOfWindowCallback` - Called when analog watchdog level is out of window.
- `HAL_ADC_ErrorCallback` - Called on error.
```

--------------------------------

### HAL_I2C_EnableListen_IT

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/i2c.md

Arms address listen mode; on address match, the HAL_I2C_AddrCallback fires, then the application must start the corresponding slave Tx/Rx transfer.

```APIDOC
## HAL_I2C_EnableListen_IT

### Description
Arms address listen mode; on address match, the HAL_I2C_AddrCallback fires, then the application must start the corresponding slave Tx/Rx transfer.

### Method
Function

### Signature
HAL_StatusTypeDef HAL_I2C_EnableListen_IT(I2C_HandleTypeDef *hi2c);

### Parameters
- **hi2c** (I2C_HandleTypeDef*) - Required - Pointer to an I2C handle.

### Return Value
HAL_StatusTypeDef - HAL status.

```

--------------------------------

### HAL_ADC_Start_DMA

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/adc.md

Starts conversions with DMA transfer. Requires a linked DMA handle; returns HAL_ERROR if DMA configuration is invalid.

```APIDOC
## HAL_ADC_Start_DMA

### Description
Starts conversions with DMA transfer. Requires a linked DMA handle; returns HAL_ERROR if DMA configuration is invalid.

### Function Signature
`HAL_StatusTypeDef HAL_ADC_Start_DMA(ADC_HandleTypeDef* hadc, uint32_t* pData, uint32_t Length)`

### Parameters
- **hadc** (ADC_HandleTypeDef*) - Required - Pointer to the ADC handle.
- **pData** (uint32_t*) - Required - Pointer to the destination buffer for DMA transfer.
- **Length** (uint32_t) - Required - Number of data items to transfer.

### Return Value
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_ERROR if DMA configuration is invalid.

### Requirements
- The ADC handle must have a DMA handle linked via `__HAL_LINKDMA`.
```

--------------------------------

### HAL_DMA_Start_IT

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/dma.md

Starts a DMA transfer with interrupts enabled for transfer complete, half transfer, and transfer error. Requires the DMA state to be READY, otherwise returns HAL_BUSY.

```APIDOC
## HAL_DMA_Start_IT

### Description
Starts a DMA transfer with interrupts enabled for transfer complete, half transfer, and transfer error. Requires the DMA state to be READY, otherwise returns HAL_BUSY.

### Method
C function

### Signature
`HAL_StatusTypeDef HAL_DMA_Start_IT(DMA_HandleTypeDef *hdma, uint32_t SrcAddress, uint32_t DstAddress, uint32_t DataLength)`

### Parameters
- **hdma** (DMA_HandleTypeDef*) - Required - Pointer to the DMA handle.
- **SrcAddress** (uint32_t) - Required - Source memory address.
- **DstAddress** (uint32_t) - Required - Destination memory address.
- **DataLength** (uint32_t) - Required - Number of data items to transfer.

### Return Value
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_BUSY if state is not READY.
```

--------------------------------

### Device-side Endpoint 0 Handling with Standard Callbacks

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/usb.md

Shows initialization of the PCD handle, enabling the USB device, and implementing the SetupStage and Reset callbacks. The SetupStage callback parses the setup packet and replies via HAL_PCD_EP_Transmit/Receive on EP0; the Reset callback re-arms EP0 with 64-byte control endpoint.

```c
#include "stm32f1xx_hal_pcd.h"

PCD_HandleTypeDef hpcd;

void usb_device_init(void)
{
  hpcd.Instance = USB;
  hpcd.Init.dev_endpoints      = 8U;
  hpcd.Init.speed              = PCD_SPEED_FULL;
  hpcd.Init.phy_itface         = PCD_PHY_EMBEDDED;
  hpcd.Init.Sof_enable         = DISABLE;
  hpcd.Init.low_power_enable   = DISABLE;
  hpcd.Init.lpm_enable         = DISABLE;
  hpcd.Init.battery_charging_enable = DISABLE;
  HAL_PCD_Init(&hpcd);
  HAL_PCD_Start(&hpcd);
}

void USB_IRQHandler(void) { HAL_PCD_IRQHandler(&hpcd); }

void HAL_PCD_SetupStageCallback(PCD_HandleTypeDef *hpcd)
{
  /* parse hpcd->Setup[] and reply via HAL_PCD_EP_Transmit/Receive on EP0 */
  HAL_PCD_EP_Transmit(hpcd, 0U, (uint8_t*)desc, len);
}

void HAL_PCD_ResetCallback(PCD_HandleTypeDef *hpcd)
{
  HAL_PCD_EP_Open(hpcd, 0U, 64U, EP_TYPE_CTRL);   /* re-arm EP0 after reset */
}
```

--------------------------------

### Interrupt-driven SPI transmission with HAL_SPI_Transmit_IT

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/spi.md

Starts an interrupt-driven SPI transmission with HAL_SPI_Transmit_IT. The HAL_SPI_TxCpltCallback is invoked when the transfer finishes, allowing the next command to start. Ensure the buffer remains valid during the transfer.

```c
uint8_t buf[16];
HAL_SPI_Transmit_IT(&hspi2, buf, 16U);

void HAL_SPI_TxCpltCallback(SPI_HandleTypeDef *hspi)
{
  /* transfer finished, next command may start */
}
```

--------------------------------

### HAL_NAND_MspInit

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/memory.md

Initializes the NAND MSP.

```APIDOC
## HAL_NAND_MspInit

### Description
Initializes the NAND MSP.

### Method
Function

### Signature
`void HAL_NAND_MspInit(NAND_HandleTypeDef *hnand)`

### Parameters
- **hnand** (NAND_HandleTypeDef*) - Required - Pointer to the NAND handle.

### Return
void
```

--------------------------------

### HAL_SPI_Transmit_IT

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/spi.md

Starts an interrupt-driven transmission.

```APIDOC
## HAL_SPI_Transmit_IT

### Description
Starts an interrupt-driven transmission.

### Function Signature
```c
HAL_StatusTypeDef HAL_SPI_Transmit_IT(SPI_HandleTypeDef *hspi, uint8_t *pData, uint16_t Size);
```

### Parameters
- **hspi** (SPI_HandleTypeDef *) - Required - Pointer to the SPI handle.
- **pData** (uint8_t *) - Required - Pointer to the transmit data buffer.
- **Size** (uint16_t) - Required - Number of data items to transmit.

### Return Value
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_ERROR on failure.

### Callback
- **HAL_SPI_TxCpltCallback** - Called when the transmission is complete.

### Example
```c
uint8_t buf[16];
HAL_SPI_Transmit_IT(&hspi2, buf, 16U);

void HAL_SPI_TxCpltCallback(SPI_HandleTypeDef *hspi)
{
  /* transfer finished, next command may start */
}
```
```

--------------------------------

### HAL_ETH_Init

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/eth.md

Initializes the Ethernet MAC and DMA, sets the MAC address, and enables Tx/Rx. Calls HAL_ETH_MspInit() when the handle state is RESET.

```APIDOC
## HAL_ETH_Init

### Description
Resets MAC and DMA, sets MAC address from Init.MACAddr, enables Tx/Rx. Calls HAL_ETH_MspInit() when handle state is RESET.

### Function Signature
HAL_StatusTypeDef HAL_ETH_Init(ETH_HandleTypeDef *heth)

### Parameters
- **heth** (ETH_HandleTypeDef*) - Required - Pointer to Ethernet handle.

### Returns
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_ERROR on failure.

```

--------------------------------

### HAL_PCD_EP_Transmit

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/usb.md

Starts an IN transmission on a USB endpoint.

```APIDOC
## `HAL_PCD_EP_Transmit`

### Description
Starts an IN transmission on the specified endpoint.

### Method
Function call

### Function Signature
`HAL_StatusTypeDef HAL_PCD_EP_Transmit(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len)`

### Parameters
- `hpcd` (PCD_HandleTypeDef*) - Required - Pointer to the PCD handle structure.
- `ep_addr` (uint8_t) - Required - Endpoint address.
- `pBuf` (uint8_t*) - Required - Pointer to the data buffer.
- `len` (uint32_t) - Required - Number of bytes to transmit.

### Returns
- `HAL_StatusTypeDef` - HAL_OK, HAL_ERROR, HAL_BUSY, or HAL_TIMEOUT.
```

--------------------------------

### HAL_TIM_DMABurst_MultiReadStart

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/tim.md

Starts a multi-burst read operation.

```APIDOC
## HAL_TIM_DMABurst_MultiReadStart

### Description
Starts a multi-burst read operation.

### Method
Function

### Signature
`HAL_StatusTypeDef HAL_TIM_DMABurst_MultiReadStart(TIM_HandleTypeDef *htim, uint32_t BurstBaseAddress, uint32_t BurstRequestSrc, uint32_t *BurstBuffer, uint32_t BurstLength, uint32_t DataLength)`

### Parameters
- **htim** (TIM_HandleTypeDef*) - Required - Pointer to the timer handle.
- **BurstBaseAddress** (uint32_t) - Required - Base address for the burst (DBA).
- **BurstRequestSrc** (uint32_t) - Required - DMA request source (DMAR).
- **BurstBuffer** (uint32_t*) - Required - Pointer to the data buffer.
- **BurstLength** (uint32_t) - Required - Length of the burst.
- **DataLength** (uint32_t) - Required - Length of the data.

### Return Value
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_ERROR on failure.
```

--------------------------------

### HAL_PCD_MspInit

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/usb.md

Weak MSP initialization callback for the USB PCD.

```APIDOC
## `HAL_PCD_MspInit`

### Description
Weak callback for MSP initialization, typically used to configure GPIO, clocks, and interrupts.

### Method
Function call

### Function Signature
`void HAL_PCD_MspInit(PCD_HandleTypeDef *hpcd)`

### Parameters
- `hpcd` (PCD_HandleTypeDef*) - Required - Pointer to the PCD handle structure.

### Returns
None.
```

--------------------------------

### HAL_TIM_DMABurst_MultiWriteStart

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/tim.md

Starts a multi-burst write operation.

```APIDOC
## HAL_TIM_DMABurst_MultiWriteStart

### Description
Starts a multi-burst write operation.

### Method
Function

### Signature
`HAL_StatusTypeDef HAL_TIM_DMABurst_MultiWriteStart(TIM_HandleTypeDef *htim, uint32_t BurstBaseAddress, uint32_t BurstRequestSrc, const uint32_t *BurstBuffer, uint32_t BurstLength, uint32_t DataLength)`

### Parameters
- **htim** (TIM_HandleTypeDef*) - Required - Pointer to the timer handle.
- **BurstBaseAddress** (uint32_t) - Required - Base address for the burst (DBA).
- **BurstRequestSrc** (uint32_t) - Required - DMA request source (DMAR).
- **BurstBuffer** (const uint32_t*) - Required - Pointer to the data buffer.
- **BurstLength** (uint32_t) - Required - Length of the burst.
- **DataLength** (uint32_t) - Required - Length of the data.

### Return Value
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_ERROR on failure.
```

--------------------------------

### HAL_NAND_GetState

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/memory.md

Gets the state of the NAND handle.

```APIDOC
## HAL_NAND_GetState

### Description
Gets the state of the NAND handle.

### Method
Function

### Signature
`HAL_NAND_StateTypeDef HAL_NAND_GetState(NAND_HandleTypeDef *hnand)`

### Parameters
- **hnand** (NAND_HandleTypeDef*) - Required - Pointer to the NAND handle.

### Return
HAL_NAND_StateTypeDef - Current state of the NAND handle.
```

--------------------------------

### HAL_MMC_GetState

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/memory.md

Gets the state of the MMC handle.

```APIDOC
## HAL_MMC_GetState

### Description
Gets the state of the MMC handle.

### Method
Function

### Signature
`HAL_MMC_StateTypeDef HAL_MMC_GetState(MMC_HandleTypeDef *hmmc)`

### Parameters
- **hmmc** (MMC_HandleTypeDef*) - Required - Pointer to the MMC handle.

### Return
HAL_MMC_StateTypeDef - Current state of the MMC handle.
```

--------------------------------

### Basic bootstrap with GPIO blink using the tick

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/hal.md

Initializes the HAL, enables GPIOA clock, configures PA5 as output, and toggles it every 500 ms using HAL_Delay. Requires the STM32F1xx HAL library.

```c
#include "stm32f1xx_hal.h"

int main(void)
{
  HAL_Init();                          /* prefetch, NVIC group 4, SysTick 1 ms, HAL_MspInit() */
  __HAL_RCC_GPIOA_CLK_ENABLE();

  GPIO_InitTypeDef gpio = {0};
  gpio.Pin   = GPIO_PIN_5;
  gpio.Mode  = GPIO_MODE_OUTPUT_PP;
  gpio.Speed = GPIO_SPEED_FREQ_LOW;
  HAL_GPIO_Init(GPIOA, &gpio);

  for (;;)
  {
    HAL_GPIO_TogglePin(GPIOA, GPIO_PIN_5);
    HAL_Delay(500U);                   /* blocking 500 ms busy-wait */
  }
}
```

--------------------------------

### HAL_MMC_GetCardInfo

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/memory.md

Gets information about the MMC card.

```APIDOC
## HAL_MMC_GetCardInfo

### Description
Gets information about the MMC card.

### Method
Function

### Signature
`HAL_StatusTypeDef HAL_MMC_GetCardInfo(MMC_HandleTypeDef *hmmc, HAL_MMC_CardInfoTypeDef *pCardInfo)`

### Parameters
- **hmmc** (MMC_HandleTypeDef*) - Required - Pointer to the MMC handle.
- **pCardInfo** (HAL_MMC_CardInfoTypeDef*) - Required - Pointer to the card info structure.

### Return
HAL_StatusTypeDef - HAL_OK on success, HAL_ERROR otherwise.
```

--------------------------------

### HAL_MMC_GetCardStatus

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/memory.md

Gets the status of the MMC card.

```APIDOC
## HAL_MMC_GetCardStatus

### Description
Gets the status of the MMC card.

### Method
Function

### Signature
`HAL_StatusTypeDef HAL_MMC_GetCardStatus(MMC_HandleTypeDef *hmmc, HAL_MMC_CardStatusTypeDef *pStatus)`

### Parameters
- **hmmc** (MMC_HandleTypeDef*) - Required - Pointer to the MMC handle.
- **pStatus** (HAL_MMC_CardStatusTypeDef*) - Required - Pointer to the status structure.

### Return
HAL_StatusTypeDef - HAL_OK on success, HAL_ERROR otherwise.
```

--------------------------------

### HAL_ETH_DMATxDescListInit

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/eth.md

Initializes the DMA Tx descriptors list.

```APIDOC
## HAL_ETH_DMATxDescListInit

### Description
Initializes the DMA Tx descriptors list.

### Method
HAL_ETH_DMATxDescListInit

### Parameters
- **heth** (ETH_HandleTypeDef*) - Pointer to an ETH_HandleTypeDef structure.
- **dma_tx_desc** (ETH_DMADescTypeDef*) - Pointer to the DMA Tx descriptor list.
- **Buffer** (uint8_t*) - Pointer to the Tx buffer.
- **NbBuff** (uint32_t) - Number of Tx buffers.

### Request Example
```c
HAL_ETH_DMATxDescListInit(&heth, dma_tx_desc, (uint8_t*)tx_buff, ETH_TXBUFNB);
```

### Response
#### Success Response
- **HAL_StatusTypeDef** - HAL_OK on success.
```

--------------------------------

### HAL_TIM_DMABurst_ReadStart

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/tim.md

Starts a DMA burst read operation.

```APIDOC
## HAL_TIM_DMABurst_ReadStart

### Description
Starts a DMA burst read operation.

### Method
Function

### Signature
`HAL_StatusTypeDef HAL_TIM_DMABurst_ReadStart(TIM_HandleTypeDef *htim, uint32_t BurstBaseAddress, uint32_t BurstRequestSrc, uint32_t *BurstBuffer, uint32_t BurstLength)`

### Parameters
- **htim** (TIM_HandleTypeDef*) - Required - Pointer to the timer handle.
- **BurstBaseAddress** (uint32_t) - Required - Base address for the burst (DBA).
- **BurstRequestSrc** (uint32_t) - Required - DMA request source (DMAR).
- **BurstBuffer** (uint32_t*) - Required - Pointer to the data buffer.
- **BurstLength** (uint32_t) - Required - Length of the burst.

### Return Value
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_ERROR on failure.
```

--------------------------------

### HAL_SD_MspInit / HAL_SD_MspDeInit

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/memory.md

Weak MSP initialization and de-initialization callbacks for the SD module.

```APIDOC
## HAL_SD_MspInit / HAL_SD_MspDeInit

### Description
Weak MSP initialization and de-initialization callbacks for the SD module.

### Function Signatures
`void HAL_SD_MspInit(SD_HandleTypeDef *hsd)`
`void HAL_SD_MspDeInit(SD_HandleTypeDef *hsd)`

### Parameters
- **hsd** (SD_HandleTypeDef*) - Required - Pointer to the SD handle.

```

--------------------------------

### HAL_TIM_DMABurst_WriteStart

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/tim.md

Starts a DMA burst write operation.

```APIDOC
## HAL_TIM_DMABurst_WriteStart

### Description
Starts a DMA burst write operation.

### Method
Function

### Signature
`HAL_StatusTypeDef HAL_TIM_DMABurst_WriteStart(TIM_HandleTypeDef *htim, uint32_t BurstBaseAddress, uint32_t BurstRequestSrc, const uint32_t *BurstBuffer, uint32_t BurstLength)`

### Parameters
- **htim** (TIM_HandleTypeDef*) - Required - Pointer to the timer handle.
- **BurstBaseAddress** (uint32_t) - Required - Base address for the burst (DBA).
- **BurstRequestSrc** (uint32_t) - Required - DMA request source (DMAR).
- **BurstBuffer** (const uint32_t*) - Required - Pointer to the data buffer.
- **BurstLength** (uint32_t) - Required - Length of the burst.

### Return Value
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_ERROR on failure.
```

--------------------------------

### HAL_ETH_Init

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/eth.md

Initializes the Ethernet peripheral with the provided configuration in the ETH_HandleTypeDef structure.

```APIDOC
## HAL_ETH_Init

### Description
Initializes the Ethernet peripheral with the provided configuration in the ETH_HandleTypeDef structure.

### Method
HAL_ETH_Init

### Parameters
- **heth** (ETH_HandleTypeDef*) - Pointer to an ETH_HandleTypeDef structure that contains the configuration information for the Ethernet module.

### Request Example
```c
ETH_HandleTypeDef heth;
heth.Instance = ETH;
heth.Init.AutoNegotiation = ETH_AUTONEGOTIATION_ENABLE;
heth.Init.Speed           = ETH_SPEED_100M;
heth.Init.DuplexMode      = ETH_MODE_FULLDUPLEX;
heth.Init.PhyAddress      = DP83848_PHY_ADDRESS;
heth.Init.MACAddr[0]      = MAC_ADDR0;
heth.Init.RxMode          = ETH_RXMODE_INTERRUPT;
heth.Init.ChecksumMode    = ETH_CHECKSUM_BY_HARDWARE;
heth.Init.MediaInterface  = ETH_MEDIA_INTERFACE_MII;
HAL_ETH_Init(&heth);
```

### Response
#### Success Response
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_ERROR or HAL_BUSY on failure.
```

--------------------------------

### HAL_CEC_Transmit_IT

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/misc-peripherals.md

Starts an interrupt-driven CEC frame transmission.

```APIDOC
## HAL_CEC_Transmit_IT

### Description
Transmits a frame over CEC in interrupt-driven mode. The transmission completion is signaled via the `HAL_CEC_TxCpltCallback` callback.

### Parameters
- `hcec` (CEC_HandleTypeDef*) - Pointer to a CEC_HandleTypeDef structure that contains the configuration information for the CEC module.
- `InitiatorAddress` (uint8_t) - The initiator logical address (0..15).
- `DestinationAddress` (uint8_t) - The destination logical address (0..15).
- `pData` (uint8_t*) - Pointer to the data buffer to transmit.
- `Size` (uint16_t) - Number of bytes to transmit.

### Returns
- HAL_StatusTypeDef - HAL_OK on success, HAL_ERROR otherwise.
```

--------------------------------

### HAL_NAND_Init

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/memory.md

Initializes the NAND interface via FSMC.

```APIDOC
## HAL_NAND_Init

### Description
Initializes the NAND interface via FSMC.

### Method
Function

### Signature
`HAL_StatusTypeDef HAL_NAND_Init(NAND_HandleTypeDef *hnand)`

### Parameters
- **hnand** (NAND_HandleTypeDef*) - Required - Pointer to the NAND handle.

### Return
HAL_StatusTypeDef - HAL_OK on success, HAL_ERROR otherwise.
```

--------------------------------

### HAL_I2C_Slave_Transmit_IT

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/i2c.md

Starts an interrupt-driven slave transmit transfer.

```APIDOC
## HAL_I2C_Slave_Transmit_IT

### Description
Starts an interrupt-driven slave transmit transfer.

### Method
Function

### Signature
HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);

### Parameters
- **hi2c** (I2C_HandleTypeDef*) - Required - Pointer to an I2C handle.
- **pData** (uint8_t*) - Required - Pointer to transmit buffer.
- **Size** (uint16_t) - Required - Number of bytes to transmit.

### Return Value
HAL_StatusTypeDef - HAL status.

```

--------------------------------

### HAL_ETH_MspInit / HAL_ETH_MspDeInit

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/eth.md

Weak functions for GPIO, clock, and NVIC initialization/deinitialization. Override in application code.

```APIDOC
## HAL_ETH_MspInit / HAL_ETH_MspDeInit

### Description
Weak functions called during HAL_ETH_Init/DeInit for low-level hardware initialization (GPIO, clock, NVIC). Override in application.

### Function Signatures
void HAL_ETH_MspInit(ETH_HandleTypeDef *heth)
void HAL_ETH_MspDeInit(ETH_HandleTypeDef *heth)

### Parameters
- **heth** (ETH_HandleTypeDef*) - Required - Pointer to Ethernet handle.

### Returns
- **void**

```

--------------------------------

### HAL_ETH_DMARxDescListInit

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/eth.md

Initializes the DMA Rx descriptors list.

```APIDOC
## HAL_ETH_DMARxDescListInit

### Description
Initializes the DMA Rx descriptors list.

### Method
HAL_ETH_DMARxDescListInit

### Parameters
- **heth** (ETH_HandleTypeDef*) - Pointer to an ETH_HandleTypeDef structure.
- **dma_rx_desc** (ETH_DMADescTypeDef*) - Pointer to the DMA Rx descriptor list.
- **Buffer** (uint8_t*) - Pointer to the Rx buffer.
- **NbBuff** (uint32_t) - Number of Rx buffers.

### Request Example
```c
HAL_ETH_DMARxDescListInit(&heth, dma_rx_desc, (uint8_t*)rx_buff, ETH_RXBUFNB);
```

### Response
#### Success Response
- **HAL_StatusTypeDef** - HAL_OK on success.
```

--------------------------------

### HAL_I2C_Slave_Receive_IT

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/i2c.md

Starts an interrupt-driven slave receive transfer.

```APIDOC
## HAL_I2C_Slave_Receive_IT

### Description
Starts an interrupt-driven slave receive transfer.

### Method
Function

### Signature
HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);

### Parameters
- **hi2c** (I2C_HandleTypeDef*) - Required - Pointer to an I2C handle.
- **pData** (uint8_t*) - Required - Pointer to receive buffer.
- **Size** (uint16_t) - Required - Number of bytes to receive.

### Return Value
HAL_StatusTypeDef - HAL status.

```

--------------------------------

### HAL_CEC_Init

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/misc-peripherals.md

Initializes the CEC peripheral with the provided configuration.

```APIDOC
## HAL_CEC_Init

### Description
Initializes the CEC peripheral, programming the CFGR register with signal-free time, tolerance, and addresses, and calls the MSP init callback if the handle is in reset state.

### Parameters
- `hcec` (CEC_HandleTypeDef*) - Pointer to a CEC_HandleTypeDef structure that contains the configuration information for the CEC module.

### Returns
- HAL_StatusTypeDef - HAL_OK on success, HAL_ERROR otherwise.
```

--------------------------------

### HAL_DMA_Start_IT

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/dma.md

Starts a DMA transfer in interrupt mode.

```APIDOC
## HAL_DMA_Start_IT

### Description
Starts a DMA transfer in interrupt mode.

### Function Signature
```c
HAL_StatusTypeDef HAL_DMA_Start_IT(DMA_HandleTypeDef *hdma, uint32_t SrcAddress, uint32_t DstAddress, uint32_t DataLength);
```

### Parameters
- **hdma** (DMA_HandleTypeDef*) - Required - Pointer to the DMA handle.
- **SrcAddress** (uint32_t) - Required - Source address.
- **DstAddress** (uint32_t) - Required - Destination address.
- **DataLength** (uint32_t) - Required - Number of data items to transfer.

### Return Value
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_ERROR on failure.

```

--------------------------------

### HAL_HCD_Init

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/usb.md

Initializes the USB host controller in host mode, configuring the core, FIFO, and host channels.

```APIDOC
## HAL_HCD_Init

### Description
Initializes the USB host controller, configuring the USB core in host mode and programming FIFO and host channels.

### Method
Function

### Parameters
- **hhcd** (HCD_HandleTypeDef*) - Required - Pointer to the HCD handle.

### Returns
- **HAL_StatusTypeDef** - Status of the initialization (HAL_OK on success).

```

--------------------------------

### HAL_DMA_Start

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/dma.md

Starts a DMA transfer in polling mode.

```APIDOC
## HAL_DMA_Start

### Description
Starts a DMA transfer in polling mode.

### Function Signature
```c
HAL_StatusTypeDef HAL_DMA_Start(DMA_HandleTypeDef *hdma, uint32_t SrcAddress, uint32_t DstAddress, uint32_t DataLength);
```

### Parameters
- **hdma** (DMA_HandleTypeDef*) - Required - Pointer to the DMA handle.
- **SrcAddress** (uint32_t) - Required - Source address.
- **DstAddress** (uint32_t) - Required - Destination address.
- **DataLength** (uint32_t) - Required - Number of data items to transfer.

### Return Value
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_ERROR on failure.

```

--------------------------------

### HAL_MMC_MspInit

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/memory.md

Initializes the MMC MSP (MCU Support Package).

```APIDOC
## HAL_MMC_MspInit

### Description
Initializes the MMC MSP (MCU Support Package).

### Method
Function

### Signature
`void HAL_MMC_MspInit(MMC_HandleTypeDef *hmmc)`

### Parameters
- **hmmc** (MMC_HandleTypeDef*) - Required - Pointer to the MMC handle.

### Return
void
```

--------------------------------

### HAL_PCD_GetState

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/usb.md

Gets the current USB device state.

```APIDOC
## `HAL_PCD_GetState`

### Description
Returns the current state of the USB device.

### Method
Function call

### Function Signature
`PCD_StateTypeDef HAL_PCD_GetState(PCD_HandleTypeDef const *hpcd)`

### Parameters
- `hpcd` (PCD_HandleTypeDef const*) - Required - Pointer to the PCD handle structure.

### Returns
- `PCD_StateTypeDef` - The current device state (e.g., PCD_STATE_RESET, PCD_STATE_READY, PCD_STATE_ERROR, PCD_STATE_BUSY, PCD_STATE_TIMEOUT).
```

--------------------------------

### HAL_SD_Init

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/memory.md

Initializes the SD card interface and performs card identification and initialization.

```APIDOC
## HAL_SD_Init

### Description
Initializes the SD card interface and performs card identification and initialization.

### Function Signature
`HAL_StatusTypeDef HAL_SD_Init(SD_HandleTypeDef *hsd)`

### Parameters
- **hsd** (SD_HandleTypeDef*) - Required - Pointer to the SD handle.

### Returns
- **HAL_StatusTypeDef** - HAL_OK on success, HAL_ERROR on failure.

```

--------------------------------

### HAL_CEC_GetLastReceivedFrameSize

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/misc-peripherals.md

Gets the size of the last received frame.

```APIDOC
## HAL_CEC_GetLastReceivedFrameSize

### Description
Returns the size of the last frame received by the CEC peripheral.

### Parameters
- `hcec` (const CEC_HandleTypeDef*) - Pointer to a constant CEC_HandleTypeDef structure.

### Returns
- uint32_t - Size in bytes of the last received frame.
```

--------------------------------

### HAL_NAND_GetError

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/memory.md

Gets the error code of the NAND handle.

```APIDOC
## HAL_NAND_GetError

### Description
Gets the error code of the NAND handle.

### Method
Function

### Signature
`uint32_t HAL_NAND_GetError(NAND_HandleTypeDef *hnand)`

### Parameters
- **hnand** (NAND_HandleTypeDef*) - Required - Pointer to the NAND handle.

### Return
uint32_t - Error code.
```

--------------------------------

### HAL_HCD_MspInit

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/usb.md

Weak initialization function for clock, GPIO, and NVIC, user-implementable.

```APIDOC
## HAL_HCD_MspInit

### Description
Weak function for initializing clock, GPIO, and NVIC for the USB host controller. Must be overridden by the user.

### Method
Function

### Parameters
- **hhcd** (HCD_HandleTypeDef*) - Required - Pointer to the HCD handle.

### Returns
- **void** - No return value.

```

--------------------------------

### HAL_MMC_GetError

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/memory.md

Gets the error code of the MMC handle.

```APIDOC
## HAL_MMC_GetError

### Description
Gets the error code of the MMC handle.

### Method
Function

### Signature
`uint32_t HAL_MMC_GetError(MMC_HandleTypeDef *hmmc)`

### Parameters
- **hmmc** (MMC_HandleTypeDef*) - Required - Pointer to the MMC handle.

### Return
uint32_t - Error code.
```

--------------------------------

### HAL_PCD_Init

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/usb.md

Initializes the USB PCD peripheral in device mode.

```APIDOC
## `HAL_PCD_Init`

### Description
Configures the USB device core in device mode, including FIFO sizing, and calls the MSP initialization callback.

### Method
Function call

### Function Signature
`HAL_StatusTypeDef HAL_PCD_Init(PCD_HandleTypeDef *hpcd)`

### Parameters
- `hpcd` (PCD_HandleTypeDef*) - Required - Pointer to the PCD handle structure.

### Returns
- `HAL_StatusTypeDef` - HAL_OK, HAL_ERROR, HAL_BUSY, or HAL_TIMEOUT.

### Remarks
Calls `HAL_PCD_MspInit()`.
```

--------------------------------

### HAL_MMC_GetCardState

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/memory.md

Gets the current state of the MMC card.

```APIDOC
## HAL_MMC_GetCardState

### Description
Gets the current state of the MMC card.

### Method
Function

### Signature
`HAL_MMC_CardStateTypeDef HAL_MMC_GetCardState(MMC_HandleTypeDef *hmmc)`

### Parameters
- **hmmc** (MMC_HandleTypeDef*) - Required - Pointer to the MMC handle.

### Return
HAL_MMC_CardStateTypeDef - Current card state.
```

--------------------------------

### HAL_PCD_EP_GetRxCount

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/usb.md

Gets the received byte count for a USB endpoint.

```APIDOC
## `HAL_PCD_EP_GetRxCount`

### Description
Returns the number of bytes received on the specified endpoint.

### Method
Function call

### Function Signature
`uint32_t HAL_PCD_EP_GetRxCount(PCD_HandleTypeDef const *hpcd, uint8_t ep_addr)`

### Parameters
- `hpcd` (PCD_HandleTypeDef const*) - Required - Pointer to the PCD handle structure.
- `ep_addr` (uint8_t) - Required - Endpoint address.

### Returns
- `uint32_t` - Number of received bytes.
```

--------------------------------

### GPIO Push-Pull Output and EXTI Wake Example

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/gpio.md

Initializes GPIOA pin 5 as push-pull output and GPIOC pin 13 as falling-edge interrupt input with pull-up. Enables EXTI15_10 interrupt and provides the IRQ handler and callback to toggle the output on pin 13 falling edge.

```c
#include "stm32f1xx_hal_gpio.h"

void gpio_init(void)
{
  __HAL_RCC_GPIOA_CLK_ENABLE();
  __HAL_RCC_GPIOC_CLK_ENABLE();

  GPIO_InitTypeDef out = {0};
  out.Pin   = GPIO_PIN_5;
  out.Mode  = GPIO_MODE_OUTPUT_PP;
  out.Speed = GPIO_SPEED_FREQ_MEDIUM;
  HAL_GPIO_Init(GPIOA, &out);

  GPIO_InitTypeDef in = {0};
  in.Pin  = GPIO_PIN_13;
  in.Mode = GPIO_MODE_IT_FALLING;          /* EXTI13 falling-edge interrupt */
  in.Pull = GPIO_PULLUP;
  HAL_GPIO_Init(GPIOC, &in);

  HAL_NVIC_SetPriority(EXTI15_10_IRQn, 2U, 0U);
  HAL_NVIC_EnableIRQ(EXTI15_10_IRQn);
}

void EXTI15_10_IRQHandler(void)
{
  HAL_GPIO_EXTI_IRQHandler(GPIO_PIN_13);  /* clears the flag, calls callback */
}

void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin)
{
  if (GPIO_Pin == GPIO_PIN_13)
  {
    HAL_GPIO_TogglePin(GPIOA, GPIO_PIN_5);
  }
}
```

--------------------------------

### HAL_HCD_HC_GetXferCount

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/usb.md

Gets the transfer count for a specified host channel.

```APIDOC
## HAL_HCD_HC_GetXferCount

### Description
Returns the number of bytes transferred on a specified host channel.

### Method
Function

### Parameters
- **hhcd** (HCD_HandleTypeDef const*) - Required - Pointer to the HCD handle.
- **chnum** (uint8_t) - Required - Channel number.

### Returns
- **uint32_t** - Number of bytes transferred.

```

--------------------------------

### HAL_HCD_HC_GetState

Source: https://github.com/stmicroelectronics/stm32f1xx-hal-driver/blob/master/_autodocs/api-reference/usb.md

Gets the channel state of a specified host channel.

```APIDOC
## HAL_HCD_HC_GetState

### Description
Returns the channel state of a specific host channel.

### Method
Function

### Parameters
- **hhcd** (HCD_HandleTypeDef const*) - Required - Pointer to the HCD handle.
- **chnum** (uint8_t) - Required - Channel number.

### Returns
- **HCD_HCStateTypeDef** - Channel state (e.g., HC_XFRC, HC_NAK).

```
Tokens:
Raw