Macros

group group_pra_macros

Defines

CY_PRA_REG32_CLR_SET(regIndex, field, value)

Provides get-clear-modify-write operations with a name field and value and writes a resulting value to the 32-bit register.

note

An attempt to access not-supported registers (not secure and not listed in the TRM) results in an error. The list of the registers that can be accessed by the PRA driver directly is defined in the cy_pra.h file with the CY_PRA_INDX_ prefix.

Parameters
  • regIndex – The register address index.

  • field – The field to be updated.

  • value – The value to write.

CY_PRA_REG32_SET(regIndex, value)

Writes the 32-bit value to the specified register.

note

An attempt to access not-supported registers (not secure and not listed in the TRM) results in an error. The list of the registers that can be accessed by the PRA driver directly is defined in the cy_pra.h file with the CY_PRA_INDX_ prefix.

Parameters
  • regIndex – The register address index.

  • value – The value to write.

CY_PRA_REG32_GET(regIndex)

Reads the 32-bit value from the specified register.

note

An attempt to access not-supported registers (not secure and not listed in the TRM) results in an error. The list of the registers that can be accessed by the PRA driver directly is defined in the cy_pra.h file with the CY_PRA_INDX_ prefix.

Parameters
  • regIndex – The register address index.

Returns

The read value.

CY_PRA_CM0_WAKEUP()

The request to wake up the Cortex-M0+ core.

CY_PRA_FUNCTION_CALL_RETURN_PARAM(msgType, funcIndex, param)

Calls the specified function with the provided parameter and returns the execution status.

Parameters
  • msgType – The function type.

  • funcIndex – The function reference.

  • param – The pointer to the function parameter.

Returns

The function execution status.

CY_PRA_FUNCTION_CALL_RETURN_VOID(msgType, funcIndex)

Calls the specified function without a parameter and returns void.

Parameters
  • msgType – The function type.

  • funcIndex – The function reference.

Returns

The function execution status.

CY_PRA_FUNCTION_CALL_VOID_PARAM(msgType, funcIndex, param)

Calls the specified function with the provided parameter and returns void.

Parameters
  • msgType – The function type.

  • funcIndex – The function reference.

  • param – The pointer to the function parameter.

CY_PRA_FUNCTION_CALL_VOID_VOID(msgType, funcIndex)

Calls the specified function without a parameter and returns void.

Parameters
  • msgType – The function type.

  • funcIndex – The function reference.

CY_PRA_GET_PIN_PROT_TYPE(base, pinNum)

Compares the PORT and PIN number with secure PIN list and returns PIN protection type.

Parameters
  • base – GPIO Port address

  • pinNum – GPIO PIN number

Returns

The categories of PIN.

CY_PRA_IS_PORT_SECURE(base)

Compares the PORT with secure PIN list and returns PORT protection status.

Parameters
  • base – GPIO Port address

Returns

true if port is secure otherwise false.

CY_PRA_GET_PORT_REG_INDEX(base, subIndex)

Compares the PORT and PIN number with secure PIN list and returns PORT index.

Parameters
  • base – GPIO Port address

  • subIndex – register index of GPIO PORT

Returns

PRA GPIO PORT register index

CY_PRA_GET_HSIOM_REG_INDEX(base, subIndex)

Compares the PORT with secure PIN list and returns HSIOM port index.

Parameters
  • base – GPIO Port address

  • subIndex – register index of HSIOM PORT

Returns

PRA HSIOM PORT register index