Skip to content

Use idiomatic return and size types #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tuupola wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Use idiomatic return and size types #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e51b51
Return int instead of int32_t
tuupola Dec 21, 2025
041d3ce
Use size_t instead of uint16_t
tuupola Dec 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
To use this library you must to provide functions for both reading and writing the I2C bus. Function definitions must be the following.

```c
int32_t i2c_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, uint16_t size);
int32_t i2c_write(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, uint16_t size);
int i2c_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, size_t size);
int i2c_write(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, size_t size);
```

Where `address` is the I2C address, `reg` is the register to read or write, `buffer` holds the data to write or read into and `size` is the amount of data to read or write. The `handle` parameter is an optional customizable argument. You can use it if your I2C implementation requires any additional information such has number of the hardware I2C driver. For example function implementations see [ESP I2C helper](https://github.com/tuupola/esp_i2c_helper). For working example see [M5StickC kitchen sink](https://github.com/tuupola/esp_m5stick).
Expand Down
4 changes: 2 additions & 2 deletions bm8563.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ extern "C" {

/* These should be provided by the HAL. */
typedef struct {
int32_t (* read)(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, uint16_t size);
int32_t (* write)(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, uint16_t size);
int (* read)(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, size_t size);
int (* write)(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, size_t size);
void *handle;
} bm8563_t;

Expand Down
20 changes: 10 additions & 10 deletions tests/mock_i2c.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,26 +39,26 @@ SPDX-License-Identifier: MIT

uint8_t memory[255] = {0};

int32_t
mock_i2c_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, uint16_t size)
int
mock_i2c_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, size_t size)
{
(void) handle;
(void) address;
memcpy(buffer, memory + reg, size);
return BM8563_OK;
}

int32_t
mock_i2c_write(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, uint16_t size)
int
mock_i2c_write(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, size_t size)
{
(void) handle;
(void) address;
memcpy(memory + reg, buffer, size);
return BM8563_OK;
}

int32_t
mock_i2c_low_voltage_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, uint16_t size)
int
mock_i2c_low_voltage_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, size_t size)
{
(void) handle;
(void) address;
Expand All @@ -67,8 +67,8 @@ mock_i2c_low_voltage_read(void *handle, uint8_t address, uint8_t reg, uint8_t *b
return BM8563_OK;
}

int32_t
mock_failing_i2c_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, uint16_t size)
int
mock_failing_i2c_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, size_t size)
{
(void) handle;
(void) address;
Expand All @@ -78,8 +78,8 @@ mock_failing_i2c_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffe
return MOCK_I2C_ERROR;
}

int32_t
mock_failing_i2c_write(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, uint16_t size)
int
mock_failing_i2c_write(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, size_t size)
{
(void) handle;
(void) address;
Expand Down
10 changes: 5 additions & 5 deletions tests/mock_i2c.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ SPDX-License-Identifier: MIT

#define MOCK_I2C_ERROR (3)

int32_t mock_i2c_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, uint16_t size);
int32_t mock_i2c_write(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, uint16_t size);
int mock_i2c_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, size_t size);
int mock_i2c_write(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, size_t size);

int32_t mock_i2c_low_voltage_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, uint16_t size);
int mock_i2c_low_voltage_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, size_t size);

int32_t mock_failing_i2c_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, uint16_t size);
int32_t mock_failing_i2c_write(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, uint16_t size);
int mock_failing_i2c_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, size_t size);
int mock_failing_i2c_write(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, size_t size);