Newnewfeat/pca #198
Merged
Newnewfeat/pca #198
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sabramz
requested changes
Nov 24, 2024
general/include/pca9539.h
Outdated
| int pca9539_write_pin(pca9539_t *pca, uint8_t reg_type, uint8_t pin, | ||
| uint8_t buf); | ||
|
|
||
| /*IGNORE THIS CODE - SERVES AS A REFERENCE |
There was a problem hiding this comment.
Remove this code if its unused
| uint16_t dev_addr; | ||
| } pca9539_t; | ||
|
|
||
| /// Init PCA9539, a 16 bit I2C GPIO expander | ||
| void pca9539_init(pca9539_t *pca, I2C_HandleTypeDef *i2c_handle, | ||
| void pca9539_init(pca9539_t *pca, WritePtr writeFunc, ReadPtr readFunc, |
There was a problem hiding this comment.
Doc comments are missing. Use doxygen, javadoc style comments seen in other repos.
general/src/pca9539.c
Outdated
| @@ -4,30 +4,112 @@ | |||
|
|
|||
| #define REG_SIZE_BITS 8 | |||
|
|
|||
| HAL_StatusTypeDef pca_write_reg(pca9539_t *pca, uint16_t address, uint8_t *data) | |||
| //RETURNS THE WRITE POINTER INSTEAD | |||
Sabramz
requested changes
Nov 25, 2024
general/src/pca9539.c
Outdated
| pca->dev_addr = dev_addr << 1u; shifted one to the left cuz STM says so | ||
| } | ||
| */ | ||
| //Read PCA9539 Register |
There was a problem hiding this comment.
These comments aren't needed since they are already in the @brief section in the header file.
| @@ -58,33 +51,30 @@ typedef struct { | |||
|
|
|||
| void pca9539_init(pca9539_t *pca, WritePtr writeFunc, ReadPtr readFunc, | |||
| uint8_t dev_addr); | |||
| /** | |||
| * @brief Initialize the PCA9539 Driver | |||
| */ | |||
There was a problem hiding this comment.
These also need to include definitions for parameters and return types. If you use VScode, you should get the doxygen extension. It autofills all that stuff for you.
Sabramz
requested changes
Dec 5, 2024
general/include/pca9539.h
Outdated
| * @param pca | ||
| * @param writeFunc | ||
| * @param readFunc | ||
| * @param dev_addr |
There was a problem hiding this comment.
You should write what each of these mean, even if its completely obvious. Follow how doxygen comments are done in other codebases, like Cerb.
added 2 commits
December 5, 2024 13:10
Sabramz
approved these changes
Dec 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Added write and read function pointers, and made i2c_handler of unspecified void* pointer so that it may point to enum that is used in HAL. Experiencing issues in the pdu.c that doesnt reflect these changes, but outside of that it works.
Notes
Any other notes go here
Test Cases
To Do
Any remaining things that need to get done
Checklist
It can be helpful to check the
ChecksandFiles changedtabs.Please reach out to your Project Lead if anything is unclear.
Please request reviewers and ping on slack only after you've gone through this whole checklist.
Closes #158 (issue #)