HPI Library

General Description

Describes the HPI master macros.

Macros

#define CY_HPI_MASTER_INTR_REG_CLEAR_DEV_INT   (0x01U)
 Mask to set/clear all HPI interrupt status bits. More...
 
#define CY_HPI_MASTER_INTR_REG_CLEAR_PORT0_INT   (0x02U)
 Mask to set/clear all HPI interrupt status bits. More...
 
#define CY_HPI_MASTER_INTR_REG_CLEAR_PORT1_INT   (0x04U)
 Mask to set/clear all HPI interrupt status bits. More...
 
#define CY_HPI_MASTER_PORT_NUMBER_0   (0U)
 HPI master Port 0 number. More...
 
#define CY_HPI_MASTER_PORT_NUMBER_1   (1U)
 HPI master Port 1 number. More...
 
#define CY_HPI_MASTER_JUMP_TO_BOOT_CMD_SIG   ('J')
 Signature to request a JUMP_TO_BOOT operation. More...
 
#define CY_HPI_MASTER_JUMP_TO_ALT_FW_SIG   ('A')
 Signature to request a JUMP_TO_ALT_FW operation. More...
 
#define CY_HPI_MASTER_ENTER_FLASHING_CMD_SIG   ('P')
 Signature to request entry to flash update mode. More...
 
#define CY_HPI_MASTER_FLASH_READ_WRITE_CMD_SIG   ('F')
 Signature for valid flash read/write requests. More...
 
#define CY_HPI_MASTER_FLASH_ROW_READ_CMD   (0x00U)
 Command code to read a flash row. More...
 
#define CY_HPI_MASTER_FLASH_ROW_WRITE_CMD   (0x01U)
 Command code to write a flash row. More...
 
#define CY_HPI_MASTER_FW_VERSION_SIZE   (8U)
 Size of the firmware binary version. More...
 
#define CY_HPI_MASTER_DEV_REG_ALL_VERSION_BYTES   (CY_HPI_MASTER_FW_VERSION_SIZE * 3)
 All HPI version register size in bytes. More...
 
#define CY_HPI_MASTER_RESET_CMD_SIG   ('R')
 Signature to request an I2C interface or device reset. More...
 
#define CY_HPI_MASTER_RESET_DEVICE_RESET_CMD   (0x01u)
 Command code for a device reset request. More...
 
#define CY_HPI_MASTER_UNKNOWN_SLAVE_IDX   (0xFFU)
 HPI slave invalid index number. More...
 

Macro Definition Documentation

◆ CY_HPI_MASTER_INTR_REG_CLEAR_DEV_INT

#define CY_HPI_MASTER_INTR_REG_CLEAR_DEV_INT   (0x01U)

Mask to set/clear all HPI interrupt status bits.

◆ CY_HPI_MASTER_INTR_REG_CLEAR_PORT0_INT

#define CY_HPI_MASTER_INTR_REG_CLEAR_PORT0_INT   (0x02U)

Mask to set/clear all HPI interrupt status bits.

◆ CY_HPI_MASTER_INTR_REG_CLEAR_PORT1_INT

#define CY_HPI_MASTER_INTR_REG_CLEAR_PORT1_INT   (0x04U)

Mask to set/clear all HPI interrupt status bits.

◆ CY_HPI_MASTER_PORT_NUMBER_0

#define CY_HPI_MASTER_PORT_NUMBER_0   (0U)

HPI master Port 0 number.

◆ CY_HPI_MASTER_PORT_NUMBER_1

#define CY_HPI_MASTER_PORT_NUMBER_1   (1U)

HPI master Port 1 number.

◆ CY_HPI_MASTER_JUMP_TO_BOOT_CMD_SIG

#define CY_HPI_MASTER_JUMP_TO_BOOT_CMD_SIG   ('J')

Signature to request a JUMP_TO_BOOT operation.

◆ CY_HPI_MASTER_JUMP_TO_ALT_FW_SIG

#define CY_HPI_MASTER_JUMP_TO_ALT_FW_SIG   ('A')

Signature to request a JUMP_TO_ALT_FW operation.

◆ CY_HPI_MASTER_ENTER_FLASHING_CMD_SIG

#define CY_HPI_MASTER_ENTER_FLASHING_CMD_SIG   ('P')

Signature to request entry to flash update mode.

◆ CY_HPI_MASTER_FLASH_READ_WRITE_CMD_SIG

#define CY_HPI_MASTER_FLASH_READ_WRITE_CMD_SIG   ('F')

Signature for valid flash read/write requests.

◆ CY_HPI_MASTER_FLASH_ROW_READ_CMD

#define CY_HPI_MASTER_FLASH_ROW_READ_CMD   (0x00U)

Command code to read a flash row.

◆ CY_HPI_MASTER_FLASH_ROW_WRITE_CMD

#define CY_HPI_MASTER_FLASH_ROW_WRITE_CMD   (0x01U)

Command code to write a flash row.

◆ CY_HPI_MASTER_FW_VERSION_SIZE

#define CY_HPI_MASTER_FW_VERSION_SIZE   (8U)

Size of the firmware binary version.

◆ CY_HPI_MASTER_DEV_REG_ALL_VERSION_BYTES

#define CY_HPI_MASTER_DEV_REG_ALL_VERSION_BYTES   (CY_HPI_MASTER_FW_VERSION_SIZE * 3)

All HPI version register size in bytes.

◆ CY_HPI_MASTER_RESET_CMD_SIG

#define CY_HPI_MASTER_RESET_CMD_SIG   ('R')

Signature to request an I2C interface or device reset.

◆ CY_HPI_MASTER_RESET_DEVICE_RESET_CMD

#define CY_HPI_MASTER_RESET_DEVICE_RESET_CMD   (0x01u)

Command code for a device reset request.

◆ CY_HPI_MASTER_UNKNOWN_SLAVE_IDX

#define CY_HPI_MASTER_UNKNOWN_SLAVE_IDX   (0xFFU)

HPI slave invalid index number.