Preskočiť na hlavný obsah

Modul MCAL I2C

Podporované rodiny STM32: H5
Nepodporované: G4, H7, L4, U5

Tento modul poskytuje abstrakčnú vrstvu na konfiguráciu a správu periférií I2C na MCU STM32H5 v režime master.
Podporuje inicializáciu, konfiguráciu frekvencie SCL s automatickým výpočtom TIMINGR, filtre šumu a prenosy dát v režime DMA, prerušení alebo pollingu.

Vlastnosti​

  • Výber zdroja kernel clock (PCLK / PLLR / HSI / CSI)
  • Frekvencia SCL v Hz - TIMINGR sa počíta z časovaní podľa špecifikácie I2C (Standard-mode, Fast-mode, Fast-mode Plus vrátane budenia FMP)
  • Analógový a digitálny filter šumu
  • 7-bitové a 10-bitové adresovanie
  • Prenosy: zápis, čítanie, zápis + opakovaný START + čítanie (prístup k registrom), iba adresa (kontrola prítomnosti zariadenia)
  • Prenosy dlhšie ako 255 bajtov (reload NBYTES)
  • Režimy prenosu dát: DMA (GPDMA), ISR, POLL (I2c_Task()) - rovnaká požiadavka, rovnaké callbacky
  • Piny SCL / SDA nakonfigurované ako alternatívna funkcia s otvoreným kolektorom (open-drain)

Nepodporované: režim slave, SMBus, obnova zbernice (slave drží SDA v nule), timeout prenosu.

Verejné API​

Správa modulu​

  • i2c_ModuleVersion_t I2c_Get_ModuleVersion(void);
  • i2c_RequestState_t I2c_Init(const i2c_Config_t * const i2cConfig);
  • i2c_RequestState_t I2c_Deinit(i2c_PeriphId_t periphId);
  • void I2c_Task(void);
  • i2c_RequestState_t I2c_Get_DefaultConfig(i2c_Config_t * const i2cConfig);

Konfigurácia periférie​

  • I2c_Set_PeriphActive / I2c_Set_PeriphInactive / I2c_Get_PeriphState
  • I2c_Set_BusFreq / I2c_Get_BusFreq (pre nastavenie je potrebné PE = 0)
  • I2c_Set_AnalogFilter / I2c_Get_AnalogFilter (pre nastavenie je potrebné PE = 0)
  • I2c_Set_DigitalFilter / I2c_Get_DigitalFilter (pre nastavenie je potrebné PE = 0)
  • I2c_Set_AddrMode / I2c_Get_AddrMode
  • I2c_Get_BusState

Prenosy dát​

  • I2c_Set_DataConfig / I2c_Get_DataConfig
  • I2c_Set_XferStart / I2c_Set_XferStop
  • I2c_Get_XferState / I2c_Get_XferError

Prerušenia​

  • I2c_Set_IrqPriority / I2c_Get_IrqPriority

Použitie​

static const i2c_DataConfig_t i2cData =
{
    .XferMode             = I2C_XFER_MODE_ISR,
    .IrqPriority          = 5u,
    .XferCompleteCallback = App_I2cDone,
    .ErrorCallback        = App_I2cError,
};

i2c_Config_t i2cConfig;

(void)I2c_Get_DefaultConfig( &i2cConfig );

i2cConfig.PeriphId   = I2C_PERIPH_1;
i2cConfig.BusFreq    = 400000u;
i2cConfig.DataConfig = &i2cData;
i2cConfig.SclPin     = (i2c_PinConfig_t)I2C_PIN_CONFIG( GPIO_PORT_B, GPIO_PIN_ID_6, GPIO_ALT_FUNC_4 ); /* check datasheet */
i2cConfig.SdaPin     = (i2c_PinConfig_t)I2C_PIN_CONFIG( GPIO_PORT_B, GPIO_PIN_ID_7, GPIO_ALT_FUNC_4 ); /* check datasheet */

(void)I2c_Init( &i2cConfig );

/* Read 2 bytes from register 0x10 of slave 0x48 */
static const i2c_Data_t regAddr = 0x10u;
static i2c_Data_t       regData[ 2u ];

const i2c_XferRequest_t request =
{
    .SlaveAddr = 0x48u,
    .TxData    = &regAddr, .TxSize = 1u,
    .RxData    = regData,  .RxSize = 2u,
};

(void)I2c_Set_XferStart( I2C_PERIPH_1, &request );

Modul nevaliduje priradenie pinov k periférii - použite alternatívnu funkciu z datasheetu zariadenia.

Integrácia s CMake​

  1. Prilinkujte I2c_Lib k svojej knižnici CMake.
  2. Zahrňte I2c_Port.h do svojho projektu.

Licencia​

Tento projekt je licencovaný pod licenciou Creative Commons Attribution–NonCommercial 4.0 International (CC BY-NC 4.0).

Úplné znenie podmienok nájdete v LICENSE.md alebo na creativecommons.org/licenses/by-nc/4.0.

Autori​