Senior Design: Sound Monitor / STM32L4xx_HAL_Driver

L4 HAL Drivers

Embed: (wiki syntax)

« Back to documentation index

Peripheral Control functions
Functions

Peripheral Control functions
[PCD Exported Functions]

management functions More...

Functions

HAL_StatusTypeDef HAL_PCD_DevConnect (PCD_HandleTypeDef *hpcd)
 Connect the USB device.
HAL_StatusTypeDef HAL_PCD_DevDisconnect (PCD_HandleTypeDef *hpcd)
 Disconnect the USB device.
HAL_StatusTypeDef HAL_PCD_SetAddress (PCD_HandleTypeDef *hpcd, uint8_t address)
 Set the USB Device address.
HAL_StatusTypeDef HAL_PCD_EP_Open (PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint16_t ep_mps, uint8_t ep_type)
 Open and configure an endpoint.
HAL_StatusTypeDef HAL_PCD_EP_Close (PCD_HandleTypeDef *hpcd, uint8_t ep_addr)
 Deactivate an endpoint.
HAL_StatusTypeDef HAL_PCD_EP_Receive (PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len)
 Receive an amount of data.
uint16_t HAL_PCD_EP_GetRxCount (PCD_HandleTypeDef *hpcd, uint8_t ep_addr)
 Get Received Data Size.
HAL_StatusTypeDef HAL_PCD_EP_Transmit (PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len)
 Send an amount of data.
HAL_StatusTypeDef HAL_PCD_EP_SetStall (PCD_HandleTypeDef *hpcd, uint8_t ep_addr)
 Set a STALL condition over an endpoint.
HAL_StatusTypeDef HAL_PCD_EP_ClrStall (PCD_HandleTypeDef *hpcd, uint8_t ep_addr)
 Clear a STALL condition over in an endpoint.
HAL_StatusTypeDef HAL_PCD_EP_Flush (PCD_HandleTypeDef *hpcd, uint8_t ep_addr)
 Flush an endpoint.
HAL_StatusTypeDef HAL_PCD_ActivateRemoteWakeup (PCD_HandleTypeDef *hpcd)
 Activate remote wakeup signalling.
HAL_StatusTypeDef HAL_PCD_DeActivateRemoteWakeup (PCD_HandleTypeDef *hpcd)
 De-activate remote wakeup signalling.

Detailed Description

management functions 

 ===============================================================================
                      ##### Peripheral Control functions #####
 ===============================================================================  
    [..]
    This subsection provides a set of functions allowing to control the PCD data 
    transfers.

Function Documentation

HAL_StatusTypeDef HAL_PCD_ActivateRemoteWakeup ( PCD_HandleTypeDef *  hpcd )

Activate remote wakeup signalling.

Parameters:
hpcd,:PCD handle
Return values:
HALstatus

Definition at line 1077 of file stm32l4xx_hal_pcd.c.

HAL_StatusTypeDef HAL_PCD_DeActivateRemoteWakeup ( PCD_HandleTypeDef *  hpcd )

De-activate remote wakeup signalling.

Parameters:
hpcd,:PCD handle
Return values:
HALstatus

Definition at line 1094 of file stm32l4xx_hal_pcd.c.

HAL_StatusTypeDef HAL_PCD_DevConnect ( PCD_HandleTypeDef *  hpcd )

Connect the USB device.

Parameters:
hpcd,:PCD handle
Return values:
HALstatus

Definition at line 783 of file stm32l4xx_hal_pcd.c.

HAL_StatusTypeDef HAL_PCD_DevDisconnect ( PCD_HandleTypeDef *  hpcd )

Disconnect the USB device.

Parameters:
hpcd,:PCD handle
Return values:
HALstatus

Definition at line 796 of file stm32l4xx_hal_pcd.c.

HAL_StatusTypeDef HAL_PCD_EP_Close ( PCD_HandleTypeDef *  hpcd,
uint8_t  ep_addr 
)

Deactivate an endpoint.

Parameters:
hpcd,:PCD handle
ep_addr,:endpoint address
Return values:
HALstatus

Definition at line 867 of file stm32l4xx_hal_pcd.c.

HAL_StatusTypeDef HAL_PCD_EP_ClrStall ( PCD_HandleTypeDef *  hpcd,
uint8_t  ep_addr 
)

Clear a STALL condition over in an endpoint.

Parameters:
hpcd,:PCD handle
ep_addr,:endpoint address
Return values:
HALstatus

Definition at line 1024 of file stm32l4xx_hal_pcd.c.

HAL_StatusTypeDef HAL_PCD_EP_Flush ( PCD_HandleTypeDef *  hpcd,
uint8_t  ep_addr 
)

Flush an endpoint.

Parameters:
hpcd,:PCD handle
ep_addr,:endpoint address
Return values:
HALstatus

Definition at line 1054 of file stm32l4xx_hal_pcd.c.

uint16_t HAL_PCD_EP_GetRxCount ( PCD_HandleTypeDef *  hpcd,
uint8_t  ep_addr 
)

Get Received Data Size.

Parameters:
hpcd,:PCD handle
ep_addr,:endpoint address
Return values:
DataSize

Definition at line 937 of file stm32l4xx_hal_pcd.c.

HAL_StatusTypeDef HAL_PCD_EP_Open ( PCD_HandleTypeDef *  hpcd,
uint8_t  ep_addr,
uint16_t  ep_mps,
uint8_t  ep_type 
)

Open and configure an endpoint.

Parameters:
hpcd,:PCD handle
ep_addr,:endpoint address
ep_mps,:endpoint max packet size
ep_type,:endpoint type
Return values:
HALstatus

Definition at line 825 of file stm32l4xx_hal_pcd.c.

HAL_StatusTypeDef HAL_PCD_EP_Receive ( PCD_HandleTypeDef *  hpcd,
uint8_t  ep_addr,
uint8_t *  pBuf,
uint32_t  len 
)

Receive an amount of data.

Parameters:
hpcd,:PCD handle
ep_addr,:endpoint address
pBuf,:pointer to the reception buffer
len,:amount of data to be received
Return values:
HALstatus

Definition at line 898 of file stm32l4xx_hal_pcd.c.

HAL_StatusTypeDef HAL_PCD_EP_SetStall ( PCD_HandleTypeDef *  hpcd,
uint8_t  ep_addr 
)

Set a STALL condition over an endpoint.

Parameters:
hpcd,:PCD handle
ep_addr,:endpoint address
Return values:
HALstatus

Definition at line 989 of file stm32l4xx_hal_pcd.c.

HAL_StatusTypeDef HAL_PCD_EP_Transmit ( PCD_HandleTypeDef *  hpcd,
uint8_t  ep_addr,
uint8_t *  pBuf,
uint32_t  len 
)

Send an amount of data.

Parameters:
hpcd,:PCD handle
ep_addr,:endpoint address
pBuf,:pointer to the transmission buffer
len,:amount of data to be sent
Return values:
HALstatus

Definition at line 949 of file stm32l4xx_hal_pcd.c.

HAL_StatusTypeDef HAL_PCD_SetAddress ( PCD_HandleTypeDef *  hpcd,
uint8_t  address 
)

Set the USB Device address.

Parameters:
hpcd,:PCD handle
address,:new device address
Return values:
HALstatus

Definition at line 810 of file stm32l4xx_hal_pcd.c.

Generated on Tue Jul 12 2022 10:58:18 by  doxygen 1.7.2