💾 ee24

A driver for 24xx I2C EEPROMs, from 24C01 to 24C512, written in C for the STM32 HAL.

Read or write any number of bytes at any address, and the library deals with the rest: pages, blocks, the chip's write time, and the limits of the HAL. It works on any STM32 family, bare metal or with FreeRTOS or ThreadX, by polling or by DMA.

✨ What you get

Any length at any address. Page boundaries, the 256 byte blocks of the small chips and the 64 KB HAL limit are all handled for you
Every size from 24C01 to 24C512, chosen per chip, so two different chips can share one project
Blocking or non-blocking, one setting. Blocking, ee24_read() and ee24_write() return once done, and the handle carries no job. Non-blocking, ee24_read_nb() and ee24_write_nb() return at once and go on a piece at a time while your code does something else, and ee24_process() moves them on
Polling or DMA, a second setting
Writes wait only as long as the chip needs, by asking it, instead of a fixed 10 ms a page
Timeouts set once, in ee24_config.h, for each step: a transfer gets time for its size, and a page for its write cycle
An optional write protect pin, lifted only while a write runs
FreeRTOS, through CMSIS-RTOS v1 or v2, and ThreadX, by way of osal: a mutex per chip, and waits that let your other threads run
A read or write past the end of the chip is refused, never wrapped round to overwrite the start
Unit tested on every commit, against a model of the chip, by polling and by DMA

🔌 Supported chips

Any 24xx serial EEPROM with an I2C bus: Microchip 24LC and 24AA, Atmel/Microchip AT24C, ST M24, onsemi CAT24, and the many compatible parts. Tell ee24_init() the number in the part name, in kilobits:

Chip	`size_kbit`	Bytes
24C01	`1`	128
24C02	`2`	256
24C04	`4`	512
24C08	`8`	1 KB
24C16	`16`	2 KB
24C32	`32`	4 KB
24C64	`64`	8 KB
24C128	`128`	16 KB
24C256	`256`	32 KB
24C512	`512`	64 KB

1 Mbit parts such as the 24LC1025 and M24M01 are not supported: each maker puts the top address bit in a different place.

📁 Layout

src/    ee24.h, ee24.c, ee24_config.h
test/   host unit tests, run on a PC

Installed into a project, the code keeps its src/ folder, with your ee24_config.h beside ee24.h, and the README, changelog and licence files around it. There is no test/: the section below about the tests refers to this repository, not to an installed copy.

⚙️ Installing it

lib-installer copies the library into your project, creates your ee24_config.h, and adds it to your CMake, STM32CubeIDE, Keil, IAR or Makefile project for you. Your project file is backed up first. It also checks that I2C is enabled in your CubeMX project, and says so if it is not.

Install it once per machine:

pip install lib-installer

Then, from the root of your STM32 project:

lib-installer nimaltd/ee24

ee24 waits and locks through osal, so the installer puts osal in first, and asks for its folder like any library. If another library already brought osal into your project, that copy is kept and nothing is asked.

From a downloaded zip

Downloaded this repository with Code, Download ZIP? Give the installer the zip in place of nimaltd/ee24, with no need to unpack it:

lib-installer D:/Downloads/ee24-main.zip

Only the files the library needs are copied into your project, and the zip is left alone. An unpacked folder works the same way. On a machine with no internet, give it the osal zip as well, lib-installer D:/Downloads/ee24-main.zip D:/Downloads/osal-main.zip, so it does not try to fetch osal. lib-installer's README has every option, and how to install on a machine with no internet at all.

Updating, and pinning a version

Run the same command again. The code is replaced, and your settings in ee24_config.h, between its USER CODE lines, are kept. osal is updated only when ee24 needs a newer one, and your setting in osal_config.h is kept the same way.

By default you get the newest code on main. To hold a project on one release, add --ref with a tag, a branch or a commit:

lib-installer nimaltd/ee24 --ref v4.0.0

Or copy the files in by hand

Copy src/ee24.h and src/ee24_config.h into your project's Core/Inc
Copy src/ee24.c into your project's Core/Src
Copy every header in the src folder of osal into Core/Inc

Or add the whole repository to a CMake build

If you keep this repository as a submodule rather than installing it:

add_subdirectory(osal)     # ee24 needs it, and links it for you
add_subdirectory(ee24)
target_link_libraries(${CMAKE_PROJECT_NAME} nimaltd::ee24)

# ee24 is a static library, so it does not inherit your application's include
# paths and defines, and ee24.h needs main.h and the HAL. A CubeMX project
# keeps them on the stm32cubemx target.
target_link_libraries(ee24 PRIVATE stm32cubemx)

The first target_link_libraries has no PRIVATE on purpose. CubeMX links your application without one, and CMake refuses to mix the two forms on one target. The settings come from ee24/src/ee24_config.h, beside ee24.h, and the RTOS setting from osal/src/osal_config.h, beside osal.h.

lib-installer avoids all of this: it writes an INTERFACE target instead, whose sources compile as part of your own target and inherit everything it has.

🔧 Configuration

ee24's settings are in ee24_config.h, between its USER CODE lines.

Blocking or non-blocking

#define EE24_MODE                       EE24_MODE_BLOCKING

Value	What you call
`EE24_MODE_BLOCKING`	`ee24_read()` and `ee24_write()`, which return once done. The default
`EE24_MODE_NON_BLOCKING`	`ee24_read_nb()` and `ee24_write_nb()`, which start a job and return at once, then `ee24_process()` or `ee24_wait()`, as below. `ee24_read()` and `ee24_write()` are there too

Pick blocking unless your code has something else to do while the chip works. Writing 1 KB to a 24C256 is 32 pages of up to 5 ms each, so ee24_write() returns after about 100 ms. With an RTOS your other threads run meanwhile, and blocking is all you need. Without one, a main loop that must keep running wants ee24_write_nb(), which returns in under a millisecond.

Blocking is also smaller and faster. Only the code for the mode you pick is compiled in, and the handle carries no job: on a 32 bit MCU with FreeRTOS or no RTOS, ee24_t is 24 bytes blocking and 48 non-blocking. A blocking read goes in as few transfers as the chip allows, 32 KB at a time, where a job by polling reads EE24_POLL_CHUNK bytes per call.

Polling or DMA

#define EE24_TRANSFER                   EE24_TRANSFER_POLLING

Value	A read or write
`EE24_TRANSFER_POLLING`	Moves its data with the CPU. The default
`EE24_TRANSFER_DMA`	Moves its data by DMA, and the CPU is free for a job or, with an RTOS, for other threads

Either mode works with either transfer. The question "has the chip stored the page yet?" always goes by polling: it is one byte, less time than a DMA takes to start. Only the code for the setting you pick is compiled in. Setting up DMA in CubeMX is described below.

How much a job reads in one call, by polling

#define EE24_POLL_CHUNK                 32U

Only for EE24_MODE_NON_BLOCKING by polling. The CPU moves every byte, so a long read would keep your code waiting for all of it: 32 KB is about 750 ms at 400 kHz, and 3 s at 100 kHz. So ee24_read_nb() reads the first piece of at most EE24_POLL_CHUNK bytes, and each ee24_process() the next.

The datasheets put no limit on a read: a chip sends byte after byte for as long as it is asked, to the end of its memory. The 32 shipped is the biggest page, so a read piece takes as long as writing a page does, and no _nb call keeps your code longer than that:

`EE24_POLL_CHUNK`	One call at 400 kHz	At 100 kHz	1 KB in all, with `ee24_read()`
32, shipped	0.8 ms	3.3 ms	26 ms
256	5.9 ms	23 ms	23 ms

Bigger pieces are faster in all, since each piece sends the address again, 3 or 4 bytes, but keep each call longer. Any value from 1 to 32768 works. A read no longer than one piece is done when ee24_read_nb() returns. Blocking, or with DMA, the setting is not used.

Timeouts

Each step has its own time, in milliseconds, after which it ends with EE24_ERR_TIMEOUT. HAL_MAX_DELAY in any of them waits for ever, as it does in the HAL:

Setting	For	Shipped
`EE24_TIMEOUT_MUTEX_MS`	Waiting for another thread to finish with the chip	`HAL_MAX_DELAY`
`EE24_TIMEOUT_TRANSFER_MS`	Moving data on the bus, for every 256 bytes a transfer carries	35
`EE24_TIMEOUT_PAGE_MS`	The chip storing one page, 5 ms at most on most chips, 10 ms on some older ones	15

The transfer time grows with the size, because a transfer's time does. 256 bytes take 23 ms at 100 kHz, the slowest clock the chips are made for, and 6 ms at 400 kHz, so 35 ms covers 100 kHz with half again to spare. A page, 32 bytes at most, gets 35 ms, and so does a read piece of up to 256 bytes. A bigger piece gets more: 300 bytes get 70 ms, two shares, and with DMA, which reads 32 KB at a time, each half of a 24C512 gets 128 shares, 4.5 s, and takes about 3 s at 100 kHz. A clock slower than 100 kHz needs a bigger value.

The page time is for each page, not the whole write. Writing 1 KB to a 24C256 is 32 pages, and each gets its own 15 ms. Waiting for the mutex for ever is safe: whoever has the chip gives it back within the other times.

The RTOS

The RTOS setting lives in your osal_config.h, where every NimaLTD library that uses osal reads it:

#define OSAL_RTOS           OSAL_RTOS_NONE

Value	For
`OSAL_RTOS_NONE`	Bare metal, no RTOS
`OSAL_RTOS_CMSIS_V1`	FreeRTOS through CMSIS-RTOS v1, `cmsis_os.h`
`OSAL_RTOS_CMSIS_V2`	FreeRTOS through CMSIS-RTOS v2, `cmsis_os2.h`
`OSAL_RTOS_THREADX`	ThreadX, `tx_api.h`

In CubeMX, FreeRTOS asks which CMSIS-RTOS interface to use when you enable it. Pick the same one here. What changes with an RTOS is described below.

🚀 Getting started

Enable I2C in CubeMX, then:

#include "ee24.h"

ee24_t eeprom;

int main(void)
{
    /* ... HAL init, MX_I2C1_Init() ... */

    if (ee24_init(&eeprom, &hi2c1, EE24_ADDRESS_DEFAULT, 256, NULL, 0) == EE24_ERR_NONE)
    {
        uint8_t data[64] = "Hello, EEPROM";

        ee24_write(&eeprom, 0, data, sizeof(data));
        ee24_read(&eeprom, 0, data, sizeof(data));
    }

    while (1)
    {
    }
}

256 says the chip is a 24C256. The last two arguments are the write protect pin, NULL and 0 when it is not wired to the MCU.

ee24_read() and ee24_write() return once done, and say how it went: EE24_ERR_NONE when it worked, which is 0. So check for it by name: if (ee24_write(...)) would mean "if it failed". The same code works in both modes, by polling and with DMA. To get on with other work while the chip writes, set EE24_MODE_NON_BLOCKING and use the _nb calls, as below.

Keeping settings in it

The usual job for an EEPROM is to keep a few settings over a power cycle. A struct goes in and out as it is:

typedef struct
{
    uint32_t magic;       /* tells a written chip from a new one, which reads 0xFF */
    uint16_t volume;
    uint8_t  language;
} settings_t;

settings_t settings;

void settings_load(void)
{
    if ((ee24_read(&eeprom, 0, (uint8_t *)&settings, sizeof(settings)) != EE24_ERR_NONE) ||
        (settings.magic != 0x5E771265))
    {
        settings.magic    = 0x5E771265;
        settings.volume   = 50;
        settings.language = 0;
    }
}

void settings_save(void)
{
    ee24_write(&eeprom, 0, (const uint8_t *)&settings, sizeof(settings));
}

An EEPROM cell survives around a million writes. That is a lot for a setting a person changes, and not much for something written every second, so save when a value changes, not on a timer.

Jobs: EE24_MODE_NON_BLOCKING

ee24_write() returns once the chip has stored the last page. Each page takes the chip up to 5 ms, so 1 KB on a 24C256, 32 pages, keeps the call about 100 ms. With an RTOS your other threads run meanwhile. Without one your code does nothing else for those 100 ms, and that is what EE24_MODE_NON_BLOCKING and its _nb calls are for.

ee24_read_nb() and ee24_write_nb() start a job: the call does the first piece and returns at once, under a millisecond at 400 kHz. A write sends a page, and the chip stores it by itself, so the CPU is yours meanwhile. A read by polling moves one piece of EE24_POLL_CHUNK bytes per call; with DMA it moves by itself. Two calls follow a job:

ee24_process() moves the job one step and returns: true while it runs. For a write it asks the chip whether it has stored the page, and once it has, sends the next one. For a read by polling it reads the next piece. Call it from a state machine or the main loop.
ee24_wait() calls ee24_process() until the job has ended, and returns how it ended. With an RTOS it sleeps a millisecond at a time through osal while the chip or the DMA has the job, so other threads run. Without one nothing else could run meanwhile, so it takes the next step at once and the job ends as soon as it can. The pieces of a read by polling it reads one after the other either way. Called once ee24_process() has said false, it returns at once.

/* In a state machine: start the write, and come back to it. */
case STATE_SAVE:
    ee24_write_nb(&eeprom, 0, (const uint8_t *)&settings, sizeof(settings));
    state = STATE_SAVING;
    break;

case STATE_SAVING:
    if (!ee24_process(&eeprom))
    {
        state = (ee24_wait(&eeprom) == EE24_ERR_NONE) ? STATE_IDLE : STATE_FAILED;
    }
    break;

A page goes out, and a piece is read, only when ee24_process() or ee24_wait() asks, so a state machine that comes back every 10 ms writes one page, or reads one piece, every 10 ms. Come back every millisecond, or less, and a job runs as fast as the chip and the bus allow.

ee24_wait() also reports a _nb call that was refused at once, past the end of the chip for one. Until a job has ended, its buffer must stay where it is and unchanged, and any other ee24 call on that chip returns EE24_ERR_BUSY, the calls that wait included. Each step of a job keeps to its own time from ee24_config.h, and a step that takes longer ends the job with EE24_ERR_TIMEOUT.

The address

Pick the address from how the chip's A0, A1 and A2 pins are wired. The name lists the pins tied high, and the others are tied to ground, so up to eight chips can share one bus:

A2	A1	A0	Address	Value
GND	GND	GND	`EE24_ADDRESS_DEFAULT`	`0xA0`
GND	GND	VCC	`EE24_ADDRESS_A0`	`0xA2`
GND	VCC	GND	`EE24_ADDRESS_A1`	`0xA4`
GND	VCC	VCC	`EE24_ADDRESS_A0_A1`	`0xA6`
VCC	GND	GND	`EE24_ADDRESS_A2`	`0xA8`
VCC	GND	VCC	`EE24_ADDRESS_A0_A2`	`0xAA`
VCC	VCC	GND	`EE24_ADDRESS_A1_A2`	`0xAC`
VCC	VCC	VCC	`EE24_ADDRESS_A0_A1_A2`	`0xAE`

The value is in the 8 bit form the HAL uses.

The 24C04, 24C08 and 24C16 use some of those pins for the memory address instead: a 24C04 ignores A0, a 24C08 A0 and A1, and a 24C16 all three. ee24_init() ignores the same pins, so the address only has to match the pins the chip does use. Fewer of these chips fit on one bus: four 24C04, two 24C08 and one 24C16.

Some makers' 24C01 and 24C02, such as Microchip's 24LC01B and 24LC02B, ignore all three pins and always answer at 0xA0. Check the datasheet.

Write protect

With the WP pin wired to the MCU, set it up in CubeMX as a GPIO output, give it a name such as EE_WP, and pass it in:

ee24_init(&eeprom, &hi2c1, EE24_ADDRESS_DEFAULT, 256, EE_WP_GPIO_Port, EE_WP_Pin);

The chip is protected from ee24_init() on. A write lifts the protection only while it runs, and puts it back on every way out, errors included. Not wired, tie WP to ground on the board and pass NULL and 0.

DMA

By polling the CPU moves the data. At 400 kHz, 1 KB takes about 23 ms on the wire, and by polling the CPU spends those 23 ms in the HAL, a piece per call. By DMA it is free for them. A write by DMA gains little: a page is 32 bytes at most, under a millisecond on the wire, and the chip's 5 ms to store it is free time either way. DMA pays off most for reads of a few hundred bytes or more.

For DMA, set up CubeMX like this:

In the I2C's DMA Settings, add a stream for I2Cx_RX and one for I2Cx_TX, both Normal mode, byte wide
In NVIC Settings, enable the I2C event interrupt and the I2C error interrupt. CubeMX enables the DMA stream interrupts for you
Set EE24_TRANSFER to EE24_TRANSFER_DMA in ee24_config.h

A DMA transfer that takes longer than its time, with the bus held low or an interrupt missing, cannot be stopped part way through the HAL. So ee24 sets the I2C up again with HAL_I2C_DeInit() and HAL_I2C_Init(), which runs CubeMX's HAL_I2C_MspInit() and its DMA setup, and the job ends with EE24_ERR_TIMEOUT. The next call can then use the I2C.

On an F7 or H7 with the data cache on, the DMA and the CPU can see different copies of a buffer. Keep the buffers in memory the cache does not cover, or turn the cache off. On an H7, DMA1 and DMA2 cannot reach the DTCM RAM at 0x20000000, so keep the buffers in AXI SRAM at 0x24000000 or higher.

With an RTOS

Set OSAL_RTOS in your osal_config.h and each chip gets its own mutex, created by ee24_init(). A call that finds another thread using the chip waits for it, up to EE24_TIMEOUT_MUTEX_MS. Blocking, that is every call: two threads that read and write the same chip simply take turns. While a job waits for the chip or the DMA, ee24_read(), ee24_write() and ee24_wait() sleep a tick at a time through osal_pause(), and your other threads run. Between the pieces of a read by polling they only yield, through osal_yield(): the threads of the same priority get a turn, and the read is not slowed.

Start the RTOS first. With one set, call every ee24 function from a thread, ee24_init() included, and never from main() before the kernel starts: the mutex and the sleeps need a running RTOS. So settings are loaded at the top of your first thread:

void StartDefaultTask(void *argument)
{
    ee24_init(&eeprom, &hi2c1, EE24_ADDRESS_DEFAULT, 256, NULL, 0);
    settings_load();

    for (;;)
    {
        /* ... */
    }
}

With EE24_MODE_NON_BLOCKING, a job holds the mutex from the call that starts it until ee24_process() or ee24_wait() sees it end, so call those from the thread that started it. A call from another thread while a job runs gets EE24_ERR_BUSY at once, rather than waiting, so that thread can try again later. ee24_wait() sleeps between its questions; a loop of your own around ee24_process() should too, osDelay(1) for one, rather than spin.

The mutex is per chip, not per bus. Two chips on one bus used from two threads at once would collide on the bus. Usually the HAL refuses the second transfer, which comes back as EE24_ERR_I2C, but that is luck rather than safety. Use both chips from one thread, or guard the bus with a mutex of your own.

What is safe to call from an interrupt

Nothing. By polling each call waits on the bus for its piece, ee24_process() asks the chip over it, and with an RTOS every call takes a mutex. Hand the work to a task or to the main loop instead, for example with seq.

🧰 API

Function	What it does
`ee24_err_t ee24_init(ee24_t handle, I2C_HandleTypeDef hi2c, uint8_t dev_address, uint16_t size_kbit, GPIO_TypeDef *wp_port, uint16_t wp_pin)`	Set up a handle for one chip and check that it answers. Call it once per handle
`ee24_err_t ee24_read(ee24_t handle, uint32_t address, uint8_t data, size_t len)`	Read `len` bytes from `address`, and return once they are in
`ee24_err_t ee24_write(ee24_t handle, uint32_t address, const uint8_t data, size_t len)`	Write `len` bytes to `address`, and return once the chip has stored them

With EE24_MODE_NON_BLOCKING, four more:

Function	What it does
`ee24_err_t ee24_read_nb(ee24_t handle, uint32_t address, uint8_t data, size_t len)`	Start reading `len` bytes from `address`, as a job, and return at once
`ee24_err_t ee24_write_nb(ee24_t handle, uint32_t address, const uint8_t data, size_t len)`	Start writing `len` bytes to `address`, as a job, and return at once
`bool ee24_process(ee24_t *handle)`	Move the job one step, and return at once: `true` while it runs
`ee24_err_t ee24_wait(ee24_t *handle)`	Wait until the job has ended, and return how it ended

Error	Means
`EE24_ERR_NONE`	Done, or from a `_nb` call, started
`EE24_ERR_INVALID`	A size that is not a 24xx size, or a handle `ee24_init()` did not accept
`EE24_ERR_RANGE`	`address + len` runs past the end of the chip. Nothing was sent
`EE24_ERR_I2C`	The chip did not answer, or the transfer failed. Check the wiring, the address and the pull ups. With DMA, also a DMA error
`EE24_ERR_TIMEOUT`	A step took longer than `ee24_config.h` allows, or another thread kept the chip too long
`EE24_ERR_MUTEX`	The RTOS could not create the mutex, usually a heap that is too small, or refused it, as from an interrupt
`EE24_ERR_BUSY`	A job is still running, so this call was refused. Nothing was sent

When ee24_init() fails, the handle is refused by every read and write until a later ee24_init() succeeds. After an error part way through a write, the pages before the failing one are written.

A NULL pointer is a bug in the calling code, so it is not returned as an error: assert_param() stops at it, the way the HAL does. That needs Enable Full Assert in CubeMX (Project Manager, Code Generator), which defines USE_FULL_ASSERT. Turn it on while developing, and a NULL lands in assert_failed() with the file and line. Without it, nothing checks.

🧪 Running the tests

The tests run on your PC, not on hardware. The HAL calls land on a model of a 24xx chip that behaves as the datasheets describe: a write wraps inside its page, a busy chip does not answer, and WP blocks writes. Time is faked, so a write cycle is tested instantly, and so is a DMA transfer, which ends once the clock passes its end. You need cmake and any C compiler, nothing else: Unity is vendored into test/unity/, so there is nothing to install.

One command does everything:

python test/run_tests.py

It configures, builds and runs the suite, then tells you plainly whether it passed. The suite is built ten times: for each EE24_MODE and each EE24_TRANSFER, with an RTOS and without one, where nothing may sleep, then with jobs reading 32 KB a call by polling, then with every time HAL_MAX_DELAY. A test of what only a job does runs only in the non-blocking builds. osal is replaced by a fake the tests control, so a mutex held by another thread, or refused by the RTOS, is tested with no RTOS at all. The RTOS side itself is osal's, and osal's own tests cover it. Add --clean to start from an empty build folder.

If you prefer doing it by hand:

cmake -S . -B build -DEE24_BUILD_TESTS=ON
cmake --build build
ctest --test-dir build --output-on-failure

⬆️ Coming from version 3

The CubeMX pack is replaced by lib-installer, and every name changed:

Was	Is now
`EE24_HandleTypeDef`	`ee24_t`
`EE24_Init(&h, &hi2c1, address)`	`ee24_init(&h, &hi2c1, address, size_kbit, wp_port, wp_pin)`
`EE24_Read(...)`, `EE24_Write(...)`	`ee24_read(...)`, `ee24_write(...)`, without the timeout, which is in `ee24_config.h` now
`NimaLTD.I-CUBE-EE24_conf.h`	`ee24_config.h`, and the RTOS in `osal_config.h`, from osal
`EE24_SIZE`	the `size_kbit` argument of `ee24_init()`
`EE24_USE_WP_PIN`	the `wp_port` and `wp_pin` arguments
`EE24_RTOS`	`OSAL_RTOS`
`EE24_RTOS_DISABLE`	`OSAL_RTOS_NONE`

One to watch, because the compiler finds every renamed function for you, but not this. The functions used to return true when they worked, and now return EE24_ERR_NONE, which is 0:

if (EE24_Read(&ee24, 0, data, 16, 100))                 /* was */
if (ee24_read(&ee24, 0, data, 16) == EE24_ERR_NONE)     /* is now */
if (ee24_read(&ee24, 0, data, 16))                      /* compiles, and means "if it failed" */

ee24_read() and ee24_write() still return once done, as before. The _nb calls are new, for code that has other work to do meanwhile: set EE24_MODE_NON_BLOCKING for them.

With an RTOS, ee24 is now called from a thread only, as above.

You also no longer need CubeMX's "Generate peripheral initialization as a pair of .c/.h files per peripheral": ee24.h includes main.h now, not i2c.h.

🛠️ Troubleshooting

ee24_init() returns EE24_ERR_I2C. The chip did not acknowledge its address. Check SDA and SCL, the pull up resistors (4.7k to the supply is usual), the supply itself, and that the address matches the A0 to A2 pins.

STM32F1: the I2C bus is busy from the start. On the F1, CubeMX enables the I2C clock after it sets up the pins, and some parts then start with a stuck bus. Enable the clock first, in the user code block at the top of HAL_I2C_MspInit() in i2c.c or stm32f1xx_hal_msp.c:

/* USER CODE BEGIN I2C1_MspInit 0 */
__HAL_RCC_I2C1_CLK_ENABLE();
/* USER CODE END I2C1_MspInit 0 */

Use I2C2 in both names for the second bus.

EE24_ERR_BUSY from a read or a write. A job started with a _nb call is still running on that chip. Call ee24_wait(), or wait for ee24_process() to say false, before the next call.

With DMA, every read or write ends in EE24_ERR_TIMEOUT. The DMA transfer never finishes. Check that the I2C has a DMA stream for RX and for TX, and that the I2C event and error interrupts are enabled in CubeMX's NVIC settings.

EE24_ERR_MUTEX from ee24_init(). The RTOS could not create the mutex, which almost always means its heap is full. Make configTOTAL_HEAP_SIZE bigger in CubeMX's FreeRTOS settings.

🤝 Contributing

Bug reports and pull requests are welcome. See CONTRIBUTING.md for the style rules and how to run the tests. Nothing to sign, just open a pull request.

💖 Support

I write these libraries in my own time and give them away, because good tools should be easy to get. If this one saved you an afternoon, there are two things that genuinely help:

⭐ Star the repo. It costs you one click, it helps other engineers find the library, and it is the main reason I keep going.

☕ Buy me a coffee on Ko-fi. Any amount is a real motivation to keep writing, documenting and maintaining this work.

📜 License

Apache License 2.0. See LICENSE.md.

You are free to use this in commercial and closed source products. What the license asks in return is that you keep the copyright notice and pass along the NOTICE file, so the credit travels with the code.

The test folder vendors Unity under its own MIT license, kept in test/unity/LICENSE.txt. It is only used for testing and is not part of what you flash to a device.

Name		Name	Last commit message	Last commit date
.github		.github
src		src
test		test
.clang-format		.clang-format
.gitattributes		.gitattributes
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CMakeLists.txt		CMakeLists.txt
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE.md		LICENSE.md
NOTICE		NOTICE
README.md		README.md
installer.yml		installer.yml

Navigation Menu

Repository navigation

About

Repository files navigation

💾 ee24

✨ What you get

🔌 Supported chips

📁 Layout

⚙️ Installing it

From a downloaded zip

Updating, and pinning a version

Or copy the files in by hand

Or add the whole repository to a CMake build

🔧 Configuration

Blocking or non-blocking

Polling or DMA

How much a job reads in one call, by polling

Timeouts

The RTOS

🚀 Getting started

Keeping settings in it

Jobs: EE24_MODE_NON_BLOCKING

The address

Write protect

DMA

With an RTOS

What is safe to call from an interrupt

🧰 API

🧪 Running the tests

⬆️ Coming from version 3

🛠️ Troubleshooting

🤝 Contributing

💖 Support

📜 License

About

Releases

Sponsor this project

Packages

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

💾 ee24

✨ What you get

🔌 Supported chips

📁 Layout

⚙️ Installing it

From a downloaded zip

Updating, and pinning a version

Or copy the files in by hand

Or add the whole repository to a CMake build

🔧 Configuration

Blocking or non-blocking

Polling or DMA

How much a job reads in one call, by polling

Timeouts

The RTOS

🚀 Getting started

Keeping settings in it

Jobs: EE24_MODE_NON_BLOCKING

The address

Write protect

DMA

With an RTOS

What is safe to call from an interrupt

🧰 API

🧪 Running the tests

⬆️ Coming from version 3

🛠️ Troubleshooting

🤝 Contributing

💖 Support

📜 License

About

Topics

Resources

Contributing

Stars

Watchers

Forks

Releases

Sponsor this project

Packages

Contributors

Languages