Skip to content
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

I2C Driver Implementation with RTOS STM32 HAL #32

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from
Draft

I2C Driver Implementation with RTOS STM32 HAL #32

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
cc51c1a
Initialized I2C driver header file with peripheral definitions and fu…
taisirhassan Nov 20, 2024
8caedb8
forgot to run clang-format on the i2c.h files so wasn't passing the c…
taisirhassan Nov 20, 2024
ca06f01
ok actually fixed the clang formatting issues this time
taisirhassan Nov 20, 2024
31bfd67
Update I2C peripheral definitions for new IMU sensors
taisirhassan Nov 20, 2024
fd19b08
Refactored I2C header to include common rocketlib and update status t…
taisirhassan Nov 20, 2024
e14ea21
Fix include path for common rocketlib in I2C header
taisirhassan Nov 20, 2024
addd7f0
Made write_reg data const since read-only, and change len to uint8_t
taisirhassan Nov 20, 2024
ad049a5
Add linker directory for third-party libraries and reorder includes i…
taisirhassan Nov 20, 2024
cad0cf0
Rename I2C peripheral type to device and update related function sign…
taisirhassan Nov 20, 2024
d5acc16
Enhance I2C header documentation and improve function comments for cl…
taisirhassan Dec 20, 2024
ca35167
Add fff submodule for mock testing and update submodule references
taisirhassan Dec 20, 2024
80c1339
Merge branch 'main' into i2c-driver
taisirhassan Dec 21, 2024
337ae4f
Refactor I2C header file: update include path for common.h because bu…
taisirhassan Dec 21, 2024
bab3de0
formatted using clang
taisirhassan Dec 21, 2024
8ff5200
Remove Movella MTi-630 IMU from supported I2C devices list
taisirhassan Dec 24, 2024
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
1 change: 1 addition & 0 deletions .cproject
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
</tool>
<tool id="com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.c.linker.1786407102" name="MCU GCC Linker" superClass="com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.c.linker">
<option id="com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.c.linker.option.script.303076356" name="Linker Script (-T)" superClass="com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.c.linker.option.script" value="${workspace_loc:/${ProjName}/STM32H733VGTX_FLASH.ld}" valueType="string"/>
<option IS_BUILTIN_EMPTY="false" IS_VALUE_EMPTY="true" id="com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.c.linker.option.directories.1811723870" name="Library search path (-L)" superClass="com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.c.linker.option.directories" valueType="libPaths"/>
<inputType id="com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.c.linker.input.1306985313" superClass="com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.c.linker.input">
<additionalInput kind="additionalinputdependency" paths="$(USER_OBJS)"/>
<additionalInput kind="additionalinput" paths="$(LIBS)"/>
Expand Down
3 changes: 3 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
[submodule "src/third_party/rocketlib"]
path = src/third_party/rocketlib
url = https://github.com/waterloo-rocketry/rocketlib
[submodule "tests/mocks/fff"]
path = tests/mocks/fff
url = https://github.com/meekrosoft/fff.git
1 change: 1 addition & 0 deletions src/drivers/i2c/i2c.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#include "i2c.h"
37 changes: 37 additions & 0 deletions src/drivers/i2c/i2c.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
#ifndef I2C_H
#define I2C_H

#include "common.h" // Common definitions
#include <stdint.h> // Standard integer types

// Supported I2C devices
typedef enum {
I2C_DEVICE_POLULU, // Polulu AltIMU-v6
I2C_DEVICE_MOVELLA, // Movella MTi-630 IMU
taisirhassan marked this conversation as resolved.
Show resolved Hide resolved
I2C_DEVICE_ST, // ST LSM6DSO32 IMU
I2C_DEVICE_COUNT // Number of devices
} i2c_device_t;

// Initialize an I2C device
// device: I2C device to initialize
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're commenting in this level of detail might as well use doxygen

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

honestly had no idea on what level of detail I should've utilized but would doxygen be good atp if we're assuming the user isn't familiar with the design document? @celery6

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any code on its own should always contain documentation regardless of whether design doc exists or not.

Idc about doxygen or any other style tbh but sure lets make doxygen style our standard from now on

// timeout_ms: Operation timeout in milliseconds
// Returns: Status code indicating success or failure
w_status_t i2c_init(i2c_device_t device, uint32_t timeout_ms);
taisirhassan marked this conversation as resolved.
Show resolved Hide resolved

// Read data from a device register
// device: I2C device
// reg: Register address
// data: Buffer to store read data
// len: Number of bytes to read (max 255)
// Returns: Status code indicating success or failure
w_status_t i2c_read_reg(i2c_device_t device, uint8_t reg, uint8_t *data, uint8_t len);

// Write data to a device register
// device: I2C device
// reg: Register address
// data: Data to write
// len: Number of bytes to write
// Returns: Status code indicating success or failure
w_status_t i2c_write_reg(i2c_device_t device, uint8_t reg, const uint8_t *data, uint8_t len);
taisirhassan marked this conversation as resolved.
Show resolved Hide resolved

#endif // I2C_H
2 changes: 1 addition & 1 deletion src/third_party/canlib
Open in desktop
Submodule canlib updated 25 files
+2 −2 can.h
+0 −919 can_common.c
+0 −459 can_common.h
+10 −5 canlib.h
+7 −8 dspic33epxxxgp50x/dspic33epxxxgp50x_can.c
+18 −4 mcp2515/mcp_2515.c
+130 −0 message/msg_actuator.c
+60 −0 message/msg_actuator.h
+96 −0 message/msg_common.c
+40 −0 message/msg_common.h
+196 −0 message/msg_general.c
+108 −0 message/msg_general.h
+246 −0 message/msg_gps.c
+96 −0 message/msg_gps.h
+93 −0 message/msg_recovery.c
+44 −0 message/msg_recovery.h
+229 −0 message/msg_sensor.c
+93 −0 message/msg_sensor.h
+80 −0 message/msg_state_est.c
+35 −0 message/msg_state_est.h
+95 −71 message_types.h
+17 −5 pic18f26k83/pic18f26k83_can.c
+0 −61 pic18f26k83/pic18f26k83_timer.c
+0 −17 pic18f26k83/pic18f26k83_timer.h
+1 −1 stm32h7/stm32h7_can.c
2 changes: 1 addition & 1 deletion src/third_party/rocketlib
Open in desktop
Submodule rocketlib updated 18 files
+20 −0 .github/workflows/clang-format-check.yml
+0 −20 .github/workflows/clang-format-test.yml
+1 −0 .gitignore
+13 −2 README.md
+26 −2 common/low_pass_filter.c
+3 −3 doc/conf.py
+2 −2 doc/i2c_driver.rst
+1 −0 doc/index.rst
+109 −0 doc/low_pass_filter.rst
+2 −2 doc/millis.rst
+141 −41 doc/pwm_driver.rst
+3 −0 include/common.h
+20 −2 include/low_pass_filter.h
+48 −12 include/pwm.h
+66 −0 pic18f26k83/pwm.c
+0 −78 pic18f26k83/softpwm.c
+0 −4 pic18f26k83/timer.c
+65 −5 unit_tests/low_pass_filter_test.c
1 change: 1 addition & 0 deletions tests/mocks/fff
Open in desktop
Submodule fff added at 5111c6
Loading