drivers:platform:stm32:Update STM32 I2C Drivers

jansunil commented 4 months ago

An STM32F4 macro check has been added for usage two structure members in the stm32_i2c.c, that aren't a part of STM32L5, STM32H5 family.

Pull Request Description

Please replace this with a detailed description and motivation of the changes. You can tick the checkboxes below with an 'x' between square brackets or just check them after publishing the PR. If this PR contains a breaking change, list dependent PRs and try to push all related PRs at the same time.

PR Type

[x] Bug fix (change that fixes an issue)
[ ] New feature (change that adds new functionality)
[ ] Breaking change (has dependencies in other repos or will cause CI to fail)

PR Checklist

[x] I have followed the Coding style guidelines
[x] I have performed a self-review of the changes
[x] I have commented my code, at least hard-to-understand parts
[x] I have build all projects affected by the changes in this PR
[x] I have tested in hardware affected projects, at the relevant boards
[x] I have signed off all commits from this PR
[x] I have updated the documentation (wiki pages, ReadMe etc), if applies

rbolboac commented 3 months ago

Alright, so the timing parameter will be calculated accordingly by the application. I think some documentation will be needed for this. Maybe here would be the right place for it: https://wiki.analog.com/resources/no-os/drivers/i2c I know that for the timer, I added platform specific documentation: https://wiki.analog.com/resources/no-os/drivers/timer Maybe you could update, in a similar way, the documentation for i2c, but only for stm32 platform.

rbolboac commented 3 months ago

And also, a more detailed commit description would be great.

jansunil commented 3 months ago

@rbolboac - I've added a detailed description for this

rbolboac commented 3 months ago

@rbolboac - I've added a detailed description for this

looks good, but please make sure you do not exceed 72 characters per line in the commit message.

jansunil commented 3 months ago

@rbolboac - I've added an internal wiki page to explain this- https://wiki.analog.com/resources/no-os/drivers/platform/stm32/stm32_i2c

rbolboac commented 3 months ago

@rbolboac - I've added an internal wiki page to explain this- https://wiki.analog.com/resources/no-os/drivers/platform/stm32/stm32_i2c

Hi @jansunil , I added here a subsection for STM32 platform: https://wiki.analog.com/resources/no-os/drivers/i2c Can you please move the content there? Otherwise it might be hard to find the page you have created. You can delete the page you created afterwards. I think it will be useful to also add a stm32 cubemx example with screenshots showing how the register can be configured, and then mentioning that the calculated value should be added in the i2c init param extra field. A code example for the init param extra field will be useful as well. But with actual values... they can be taken directly out of your project to serve as an example.

jansunil commented 3 months ago

@rbolboac - I've made the suggested updates now- https://wiki.analog.com/resources/no-os/drivers/i2c#stm32_platform Does it look gtg?

analogdevicesinc / no-OS