stm32h7xx_hal_pssi.h File Reference

Header file of PSSI HAL module. More...

#include "stm32h7xx_hal_def.h"

Go to the source code of this file.

Data Structures
struct	PSSI_InitTypeDef
	PSSI Init structure definition. More...
struct	__PSSI_HandleTypeDef
	PSSI handle Structure definition. More...
Defines
#define	HAL_PSSI_ERROR_NONE   0x00000000U
#define	HAL_PSSI_ERROR_NOT_SUPPORTED   0x00000001U
#define	HAL_PSSI_ERROR_UNDER_RUN   0x00000002U
#define	HAL_PSSI_ERROR_OVER_RUN   0x00000004U
#define	HAL_PSSI_ERROR_DMA   0x00000008U
#define	HAL_PSSI_ERROR_TIMEOUT   0x00000010U
#define	HAL_PSSI_ERROR_INVALID_CALLBACK   0x00000020U
#define	HAL_PSSI_8BITS   0x00000000U
#define	HAL_PSSI_16BITS   0x00000001U
#define	HAL_PSSI_32BITS   0x00000002U
#define	HAL_PSSI_8LINES   0x00000000U
#define	HAL_PSSI_16LINES   PSSI_CR_EDM
#define	HAL_PSSI_UNIDIRECTIONAL   0x00000000U
#define	HAL_PSSI_BIDIRECTIONAL   0x00000001U
#define	HAL_PSSI_DE_RDY_DISABLE   (0x0U << PSSI_CR_DERDYCFG_Pos)
#define	HAL_PSSI_RDY_ENABLE   (0x1U << PSSI_CR_DERDYCFG_Pos)
#define	HAL_PSSI_DE_ENABLE   (0x2U << PSSI_CR_DERDYCFG_Pos)
#define	HAL_PSSI_DE_RDY_ALT_ENABLE   (0x3U << PSSI_CR_DERDYCFG_Pos)
#define	HAL_PSSI_MAP_RDY_BIDIR_ENABLE   (0x4U << PSSI_CR_DERDYCFG_Pos)
#define	HAL_PSSI_RDY_MAP_ENABLE   (0x5U << PSSI_CR_DERDYCFG_Pos)
#define	HAL_PSSI_DE_MAP_ENABLE   (0x6U << PSSI_CR_DERDYCFG_Pos)
#define	HAL_PSSI_MAP_DE_BIDIR_ENABLE   (0x7U << PSSI_CR_DERDYCFG_Pos)
#define	HAL_PSSI_DEPOL_ACTIVE_LOW   0x0U
#define	HAL_PSSI_DEPOL_ACTIVE_HIGH   PSSI_CR_DEPOL
#define	HAL_PSSI_RDYPOL_ACTIVE_LOW   0x0U
#define	HAL_PSSI_RDYPOL_ACTIVE_HIGH   PSSI_CR_RDYPOL
#define	HAL_PSSI_FALLING_EDGE   0x0U
#define	HAL_PSSI_RISING_EDGE   0x1U
#define	PSSI_MAX_NBYTE_SIZE   0x10000U /* 64 KB */
#define	PSSI_TIMEOUT_TRANSMIT   0x0000FFFFU
#define	PSSI_CR_OUTEN_INPUT   0x00000000U
#define	PSSI_CR_OUTEN_OUTPUT   PSSI_CR_OUTEN
#define	PSSI_CR_DMA_ENABLE   PSSI_CR_DMAEN
#define	PSSI_CR_DMA_DISABLE   (~PSSI_CR_DMAEN)
#define	PSSI_CR_16BITS   PSSI_CR_EDM
#define	PSSI_CR_8BITS   (~PSSI_CR_EDM)
#define	PSSI_FLAG_RTT1B   PSSI_SR_RTT1B
#define	PSSI_FLAG_RTT4B   PSSI_SR_RTT4B
#define	PSSI_FLAG_OVR_RIS   PSSI_RIS_OVR_RIS
#define	PSSI_FLAG_MASK   PSSI_RIS_OVR_RIS_Msk
#define	PSSI_FLAG_OVR_MIS   PSSI_MIS_OVR_MIS
#define	HAL_PSSI_RESET_HANDLE_STATE(__HANDLE__)
	Reset PSSI handle state.
#define	HAL_PSSI_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR |= PSSI_CR_ENABLE)
	Enable the PSSI.
#define	HAL_PSSI_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR &= (~PSSI_CR_ENABLE))
	Disable the PSSI.
#define	HAL_PSSI_GET_STATUS(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->SR & (__FLAG__))
	Get the PSSI pending flags.
#define	HAL_PSSI_GET_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->RIS & (__FLAG__))
	Get the PSSI pending flags.
#define	HAL_PSSI_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->ICR = (__FLAG__))
	Clear the PSSI pending flags.
#define	HAL_PSSI_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
	Enable the specified PSSI interrupts.
#define	HAL_PSSI_DISABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
	Disable the specified PSSI interrupts.
#define	HAL_PSSI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->IER & (__INTERRUPT__))
	Check whether the specified PSSI interrupt source is enabled or not.
#define	IS_PSSI_CONTROL_SIGNAL(__CONTROL__)
	Check whether the PSSI Control signal is valid.
#define	IS_PSSI_BUSWIDTH(__BUSWIDTH__)
	Check whether the PSSI Bus Width is valid.
#define	IS_PSSI_CLOCK_POLARITY(__CLOCKPOL__)
	Check whether the PSSI Clock Polarity is valid.
#define	IS_PSSI_DE_POLARITY(__DEPOL__)
	Check whether the PSSI Data Enable Polarity is valid.
#define	IS_PSSI_RDY_POLARITY(__RDYPOL__)
	Check whether the PSSI Ready Polarity is valid.
Typedefs
typedef struct __PSSI_HandleTypeDef	PSSI_HandleTypeDef
	PSSI handle Structure definition.
typedef void(*	pPSSI_CallbackTypeDef )(PSSI_HandleTypeDef *hpssi)
	HAL PSSI Callback pointer definition.
Enumerations
enum	HAL_PSSI_StateTypeDef {   HAL_PSSI_STATE_RESET = 0x00U, HAL_PSSI_STATE_READY = 0x01U, HAL_PSSI_STATE_BUSY = 0x02U, HAL_PSSI_STATE_BUSY_TX = 0x03U,   HAL_PSSI_STATE_BUSY_RX = 0x04U, HAL_PSSI_STATE_TIMEOUT = 0x05U, HAL_PSSI_STATE_ERROR = 0x06U, HAL_PSSI_STATE_ABORT = 0x07U }
	HAL PSSI State structures definition. More...
enum	HAL_PSSI_CallbackIDTypeDef {   HAL_PSSI_TX_COMPLETE_CB_ID = 0x00U, HAL_PSSI_RX_COMPLETE_CB_ID = 0x01U, HAL_PSSI_ERROR_CB_ID = 0x03U, HAL_PSSI_ABORT_CB_ID = 0x04U,   HAL_PSSI_MSPINIT_CB_ID = 0x05U, HAL_PSSI_MSPDEINIT_CB_ID = 0x06U }
	HAL PSSI Callback ID enumeration definition. More...
Functions
HAL_StatusTypeDef	HAL_PSSI_Init (PSSI_HandleTypeDef *hpssi)
	Initializes the PSSI according to the specified parameters in the PSSI_InitTypeDef and initialize the associated handle.
HAL_StatusTypeDef	HAL_PSSI_DeInit (PSSI_HandleTypeDef *hpssi)
	DeInitialize the PSSI peripheral.
__weak void	HAL_PSSI_MspInit (PSSI_HandleTypeDef *hpssi)
	Initialize the PSSI MSP.
__weak void	HAL_PSSI_MspDeInit (PSSI_HandleTypeDef *hpssi)
	DeInitialize the PSSI MSP.
HAL_StatusTypeDef	HAL_PSSI_RegisterCallback (PSSI_HandleTypeDef *hpssi, HAL_PSSI_CallbackIDTypeDef CallbackID, pPSSI_CallbackTypeDef pCallback)
	Register a User PSSI Callback To be used instead of the weak predefined callback.
HAL_StatusTypeDef	HAL_PSSI_UnRegisterCallback (PSSI_HandleTypeDef *hpssi, HAL_PSSI_CallbackIDTypeDef CallbackID)
	Unregister an PSSI Callback PSSI callback is redirected to the weak predefined callback.
HAL_StatusTypeDef	HAL_PSSI_Transmit (PSSI_HandleTypeDef *hpssi, uint8_t *pData, uint32_t Size, uint32_t Timeout)
	Transmits in master mode an amount of data in blocking mode.
HAL_StatusTypeDef	HAL_PSSI_Receive (PSSI_HandleTypeDef *hpssi, uint8_t *pData, uint32_t Size, uint32_t Timeout)
	Receives an amount of data in blocking mode.
HAL_StatusTypeDef	HAL_PSSI_Transmit_DMA (PSSI_HandleTypeDef *hpssi, uint32_t *pData, uint32_t Size)
	Transmit an amount of data in non-blocking mode with DMA.
HAL_StatusTypeDef	HAL_PSSI_Receive_DMA (PSSI_HandleTypeDef *hpssi, uint32_t *pData, uint32_t Size)
	Receive an amount of data in non-blocking mode with DMA.
HAL_StatusTypeDef	HAL_PSSI_Abort_DMA (PSSI_HandleTypeDef *hpssi)
	Abort a DMA process communication with Interrupt.
void	HAL_PSSI_IRQHandler (PSSI_HandleTypeDef *hpssi)
	This function handles PSSI event interrupt request.
__weak void	HAL_PSSI_TxCpltCallback (PSSI_HandleTypeDef *hpssi)
	Tx Transfer complete callback.
__weak void	HAL_PSSI_RxCpltCallback (PSSI_HandleTypeDef *hpssi)
	Rx Transfer complete callback.
__weak void	HAL_PSSI_ErrorCallback (PSSI_HandleTypeDef *hpssi)
	PSSI error callback.
__weak void	HAL_PSSI_AbortCpltCallback (PSSI_HandleTypeDef *hpssi)
	PSSI abort callback.
HAL_PSSI_StateTypeDef	HAL_PSSI_GetState (PSSI_HandleTypeDef *hpssi)
	Return the PSSI handle state.
uint32_t	HAL_PSSI_GetError (PSSI_HandleTypeDef *hpssi)
	Return the PSSI error code.

---

Detailed Description

Header file of PSSI HAL module.

Author:

MCD Application Team

Attention:

Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32h7xx_hal_pssi.h.