HAL AXIM How to Use

group AXIM_How_To_Use

AXIM main features

The HAL AXIM driver provides the following main features:

1. Initiator management

   • The driver allows to manage initiators by:

     • Enabling configuration of read/write quality of service (QoS) when supported by the initiator.

     • Controlling read/write issuing capability to shape outstanding transactions.

2. Target management

   • The driver allows to configure AXI targets by:

     • Setting read/write bus matrix issuing capability to tune interconnect behavior.

3. Peripheral identification

   • The driver allows to retrieve AXIM peripheral identification data such as revision, JEP-106 information, part number, and file size.

4. Component identification

   • The driver allows to retrieve AXIM component metadata such as component class and preamble bits.

How to use the AXIM HAL module driver

The AXIM HAL driver can be used as follows :

This driver provides the HAL AXIM driver functions that allow the configuration and management of the AXI Interconnect Matrix initiators and targets and the retrieval of the AXIM peripheral and component information.

1. How to configure an AXIM initiator

   • Configure an AXIM initiator using HAL_AXIM_INI_SetConfig(), which allows to set:

     • Read/write quality of service if available for a given initiator.

     • Read/write Issuing capability.

     • Packing of beats to match the output data width.

     • Increment override.

   • Configure an AXIM initiator read quality of service by using HAL_AXIM_INI_SetReadQoS() function.

   • Configure an AXIM initiator write quality of service by using HAL_AXIM_INI_SetWriteQoS() function.

   • Configure an AXIM initiator read/write issuing capability by using HAL_AXIM_INI_SetIssuingCapability() function.

   • Configure an AXIM initiator packing by using HAL_AXIM_INI_EnablePacking() or HAL_AXIM_INI_DisablePacking() functions.

   • Configure an AXIM initiator increment override by using HAL_AXIM_INI_SetIncrementOverride() function.

2. How to configure an AXIM target

   • Configure an AXIM target globally by using HAL_AXIM_TARG_SetConfig() function, which allows to set:

     • Read/write bus matrix issuing capability.

     • Read/write issuing capability.

     • packing of beats to match the output data width.

     • Long burst generation at the output of the AMIB.

   • Configure an AXIM target read/write bus matrix issuing capability with HAL_AXIM_TARG_SetBusMatrixIssuingCapability() function.

   • Configure an AXIM target read/write issuing capability with HAL_AXIM_TARG_SetIssuingCapability() function.

   • Configure an AXIM target packing with HAL_AXIM_TARG_EnablePacking() or HAL_AXIM_TARG_DisablePacking() functions.

   • Configure an AXIM target long burst generation with HAL_AXIM_TARG_EnableLongBurst() or HAL_AXIM_TARG_DisableLongBurst() functions.

3. How to get the AXIM peripheral information

   • Get AXIM peripheral information such as the revision, JEP-106 information, part number, and file size using HAL_AXIM_GetPeripheralInfo() function.

4. How to get the AXIM component information

   • Get AXIM component information such as the component class, and preamble bits using HAL_AXIM_GetComponentInfo() function.