I2C internal peripheral

Revision as of 13:32, 3 February 2020 by Registered User (Add U-boot as runtime and removal of _ in the PMIC page link (related to boot time))

1 Article purpose[edit]

The purpose of this article is to:

  • briefly introduce the I2C peripheral and its main features
  • indicate the level of security supported by this hardware block
  • explain how each instance can be allocated to the three runtime contexts and linked to the corresponding software components
  • explain, when necessary, how to configure the I2C peripheral.

2 Peripheral overview[edit]

The I2C bus interface serves as an interface between the microcontroller and the serial I2C bus.
It provides multi-master capability, and controls all I2C bus-specific sequencing, protocol, arbitration and timing.
The I2C controller allows to be a slave as well if need be.
It is also SMBus 2.0 compatible.
For more information about I2C please refer to this link: I2C wikipedia[1] or i2c-bus.org[2]
For more information about SMBus please refer to this link: SMBus wikipedia[3] or i2c-bus.org[4]

2.1 Features[edit]

Here are the main features:

  • Multi-master
  • Standard (100 KHz) and fast speed modes (400 KHz and Plus 1 MHz)
  • I2C 10-bit address
  • I2C slave capabilities (programmable I2C address)
  • DMA capabilities
  • SMBus 2.0 compatible
    • Standard bus protocol (quick command; byte, word, block read/write)
    • Host notification
    • Alert

Refer to the STM32MP15 reference manuals for the complete list of features, and to the software components, introduced below, to see which features are implemented.

2.2 Security support[edit]

  • There are six I2C instances.
    • I2C instances 1, 2, 3 and 5 are non-secure.
    • I2C instances 4 and 6 can be secure (under ETZPC control).

3 Peripheral usage and associated software[edit]

3.1 Boot time[edit]

The I2C peripheral is usually not used at boot time. But it may be used by the SSBL and/or FSBL (see Boot chains overview), for example, to configure a PMIC (see PMIC hardware components), or to access data stored in an external EEPROM.

3.2 Runtime[edit]

3.2.1 Overview[edit]

I2C4&6 instances can be allocated to:

  • the Arm® Cortex®-A7 secure core to be controlled in OP-TEE by the OP-TEE I2C driver

All I2C instances can be allocated to:

  • the Arm® Cortex®-A7 non-secure core to be controlled in U-Boot or Linux® by the I2C framework

All but I2C4&6 instances can be allocated to:

Chapter Peripheral assignment describes which peripheral instance can be assigned to which context.

3.2.2 Software frameworks[edit]

Internal peripherals software table template

| Low speed interface
| I2C
| OP-TEE I2C driver
|  I2C Engine framework
| STM32Cube I2C driver

3.2.3 Peripheral configuration[edit]

The configuration is applied by the firmware running in the context to which the peripheral is assigned. The configuration can be done alone via the STM32CubeMX tool for all internal peripherals, and then manually completed (particularly for external peripherals), according to the information given in the corresponding software framework article.

For Linux® kernel configuration, please refer to I2C configuration.

Please refer to I2C device tree configuration for detailed information on how to configure I2C peripherals.

3.2.4 Peripheral assignment[edit]

Internal peripherals assignment table template

| rowspan="6" | Low speed interface
| rowspan="6" | I2C
| I2C1
| Assignment (single choice)
| I2C2
| Assignment (single choice)
| I2C3
| Assignment (single choice)
| I2C4
| Assignment (single choice). 
Used for PMIC control on ST boards. |- | I2C5 | | | | Assignment (single choice) |- | I2C6 | | | | Assignment (single choice) |-

4 References[edit]