SHIPCore:SHIP I2CM

Subsystem	Introduced	Description
SHIP_I2CM	v4.0	I2C Master framework to encapsulate hardware-specific peripherals and drivers.

SHIP_I2CM is a sophisticated I²C Master driver framework supporting:

• Hardware-independent API
• Multiple different types of concurrent underlying I²C hardware peripherals through plug-in drivers
• Full transactional support for single API call read-write (for example) bus transactions
• Optional error return values clearly describing the reason a function may have failed, including timeouts

SHIP_I2CM is part of SHIPCore, the foundational firmware enabling application development for Serious Communications Modules. SHIPCore is bundled in SHIPWare for Serious Communications Modules which adds the OS, BSP, drivers, and glue on top of SHIPCore to create an out-of-the-box embedded application environment.

Major Version Changes

Version	Change
v4.0.0	introduced
v5.0.0	reworked from single-peripheral/non-transactional to multi-peripheral transactional

Files

• SHIP_Core/SHIP_I2CM.h is the API definition and is automatically included by SHIP_Core.h
• SHIP_Core/SHIP_I2CM.c is the abstracted hardware-independent implementation of the initialization and transactional functions

When implemented, the low level hardware/board/peripheral driver file(s) will be present to implement this API on a platform, for example on the SCM208, Common/SHIP_MCU_I2C_RSCI.c and .h instantiate a low level driver for all Renesas MCU's SCI-based Simple I²C peripheral.