wyatt-mattas / i3c_controller_direct_command_dma

I3C_Controller_Direct_Command_DMA Example Description

How to handle a Direct Command procedure between an I3C Controller and an I3C Target, using DMA.

  - Board: NUCLEO-H563ZI (embeds a STM32H563ZI device)
  - SCL Pin: PB8 (Arduino SCL/D15 CN6 pin 2, Morpho CN5 pin3)
  - SDA Pin: PB9 (Arduino SDA/D14 CN6 pin 4, Morpho CN5 pin5)
  Connect GND between each board
  Use short wire as possible between the boards or twist an independent ground wire on each I3C lines
  mean one GND twist around SCL and one GND twist around SDA to help communication at 12.5Mhz.

At the beginning of the main program the HAL_Init() function is called to reset all the peripherals, initialize the Flash interface and the systick. Then the SystemClock_Config() function is used to configure the system clock (SYSCLK) to run at 250 MHz.

The I3C peripheral configuration is ensured by the HAL_I3C_Init() function. This later is calling the HAL_I3C_MspInit()function which core is implementing the configuration of the needed I3C resources according to the used hardware (CLOCK, GPIO, NVIC and DMA). User may update this function to change I3C configuration. To have a better signal startup, the user must adapt the parameter BusFreeDuration depends on its hardware constraint. The value of BusFreeDuration set on this example is link to Nucleo hardware environment.

The I3C communication is then initiated. The project is split in two workspaces: the Controller Board (I3C_Controller_Direct_Command_DMA) and the Target Board (I3C_Target_Direct_Command_DMA)

• Controller Board The HAL_I3C_Ctrl_DynAddrAssign_IT() function allow the Controller to manage a Dynamic Address Assignment procedure to Target connected on the bus. This communication is done at 12.5Mhz based on I3C source clock which is at 250 MHz.

  The HAL_I3C_SetConfigFifo(), the HAL_I3C_Ctrl_ReceiveCCC_DMA() and the HAL_I3C_Ctrl_TransmitCCC_DMA() functions allow respectively the configuration of the internal hardware FIFOs, the reception of associated Command value and the transmission of associated Command value using DMA mode at 12.5Mhz during Push-pull phase based on I3C source clock which is at 250 MHz.

For this example the aSET_CCCList and aGET_CCCList are predefined related to Common Command Code descriptor treated in this example.

In a first step after the user press the USER push-button on the Controller Board, I3C Controller starts the communication by initiate the Dynamic Address Assignment procedure through HAL_I3C_Ctrl_DynAddrAssign_IT(). This procedure allows the Controller to associate Dynamic Address to the Target connected on the Bus. User can verify through debug the payload value by watch the content of TargetDesc1 in the field TARGET_BCR_DCR_PID.

Then controller waiting user action.

The user press the USER push-button on the Controller Board to start the communication by sending the first then all Get CCC element of the aGET_CCCList through HAL_I3C_Ctrl_ReceiveCCC_DMA() to I3C Targets which receive the Command and treat it by sending the associated data.

At the end, Controller is informed at fully reception of Get CCC element through HAL_I3C_CtrlRxCpltCallback().

At this step, Controller compute the data receive through aRxBuffer and print it through Terminal I/O through DisplayCCCValue().

Terminal I/O watch the list of Get Command Code sent by Controller and associated Target data with IDE in debug mode. Depending of IDE, to watch content of Terminal I/O note that

• When resorting to EWARM IAR IDE: Command Code is displayed on debugger as follows: View --> Terminal I/O

• When resorting to MDK-ARM KEIL IDE: Command Code is displayed on debugger as follows: View --> Serial Viewer --> Debug (printf) Viewer

• When resorting to STM32CubeIDE: Command Code is displayed on debugger as follows: Window--> Show View--> Console. In Debug configuration :

  • Window\Debugger, select the Debug probe : ST-LINK(OpenOCD)
  • Window\Startup,add the command "monitor arm semihosting enable"

At next USER push-button press, the Controller switch to sending the first then all Set CCC element of the aSet_CCCList through HAL_I3C_Ctrl_TransmitCCC_DMA() to I3C Target which receive the Command and treat it by receiving the associated data. At the end, Controller is informed at fully transmission of Set CCC element through HAL_I3C_CtrlTxCpltCallback().

NUCLEO-H563ZI's LEDs can be used to monitor the transfer status:

• LED1 is toggle at ENTDAA reception and each time the Command Code process is completed.
• LED1 is toggle slowly when there is an error in Command Code process.

Terminal I/O watch the list of Get Command Code sent by Controller and associated Target data with IDE in debug mode. Depending of IDE, to watch content of Terminal I/O note that

• When resorting to EWARM IAR IDE: Command Code is displayed on debugger as follows: View --> Terminal I/O

• When resorting to MDK-ARM KEIL IDE: Command Code is displayed on debugger as follows: View --> Serial Viewer --> Debug (printf) Viewer

• When resorting to STM32CubeIDE: Command Code is displayed on debugger as follows: Window--> Show View--> Console. In Debug configuration :

  • Window\Debugger, select the Debug probe : ST-LINK(OpenOCD)
  • Window\Startup,add the command "monitor arm semihosting enable"

Notes

1. Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds) based on variable incremented in SysTick ISR. This implies that if HAL_Delay() is called from a peripheral ISR process, then the SysTick interrupt must have higher priority (numerically lower) than the peripheral interrupt. Otherwise the caller ISR process will be blocked. To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function.

2. The application need to ensure that the SysTick time base is always set to 1 millisecond to have correct HAL operation.

Keywords

Connectivity, Communication, I3C, Interrupt, DMA, Controller, Target, Dynamic Address Assignment, Direct Command, Transmission, Reception

Directory contents

• I3C/I3C_Controller_Direct_Command_DMA/Inc/desc_target1.h Target Descriptor
• I3C/I3C_Controller_Direct_Command_DMA/Inc/stm32h5xx_nucleo_conf.h BSP configuration file
• I3C/I3C_Controller_Direct_Command_DMA/Inc/stm32h5xx_hal_conf.h HAL configuration file
• I3C/I3C_Controller_Direct_Command_DMA/Inc/stm32h5xx_it.h I3C interrupt handlers header file
• I3C/I3C_Controller_Direct_Command_DMA/Inc/main.h Header for main.c module
• I3C/I3C_Controller_Direct_Command_DMA/Src/stm32h5xx_it.c I3C interrupt handlers
• I3C/I3C_Controller_Direct_Command_DMA/Src/main.c Main program
• I3C/I3C_Controller_Direct_Command_DMA/Src/system_stm32h5xx.c STM32H5xx system source file
• I3C/I3C_Controller_Direct_Command_DMA/Src/stm32h5xx_hal_msp.c HAL MSP file

Hardware and Software environment

• This example runs on STM32H563ZI devices.

• This example has been tested with NUCLEO-H563ZI board and can be easily tailored to any other supported device and development board.

• NUCLEO-H563ZI Set-up

  • Use short wire as possible between the boards or twist an independent ground wire on each I3C lines mean one GND twist around SCL and one GND twist around SDA to help communication at 12.5Mhz.
  • Connect I3C_SCL line of Controller board (PB8 Arduino SCL/D15 CN6 pin 2, Morpho CN5 pin3) to I3C_SCL line of Target Board (PB8 Arduino SCL/D15 CN6 pin 2, Morpho CN5 pin3).
  • Connect I3C_SDA line of Controller board (PB9 Arduino SDA/D14 CN6 pin 4, Morpho CN5 pin5) to I3C_SDA line of Target Board (PB9 Arduino SDA/D14 CN6 pin 4, Morpho CN5 pin5).
  • Connect GND of Controller board to GND of Target Board.

• Launch the program in debug mode on Controller board side, and in normal mode on Target side to benefit of Terminal I/O information on Controller side.

How to use it ?

In order to make the program work, you must do the following:

• Open your preferred toolchain
• Rebuild all files and load your image into Controller memory (I3C_Controller_Direct_Command_DMA)
• Then rebuild all files and load your image into Target memory (I3C_Target_Direct_Command_DMA)
• Run the Controller in debug mode before run the Target in normal mode. This sequence will prevent a false startup phase on Target side as there is no high level on the bus, if the Target is started before the Controller.