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

Newnewfeat/pca #198

Merged
merged 9 commits into from
Dec 5, 2024
Merged

Newnewfeat/pca #198

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4e9db2f
changes finalized
Nov 10, 2024
e5441af
finalized 2
Nov 10, 2024
824f3ef
struct fix
Nov 10, 2024
dbf5358
final final
Nov 10, 2024
c526b7c
removing the i2c_handler, preping for cerb changes
Nov 10, 2024
57ef881
Better Documentation
Nov 24, 2024
d6679ec
added doxygen comments, removed unnecessary comments
Nov 28, 2024
72c7b4c
added param & ret comments
Dec 5, 2024
3bb4e77
Merge branch 'main' of https://github.com/Northeastern-Electric-Racin…
Dec 5, 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
53 changes: 45 additions & 8 deletions general/include/pca9539.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,18 @@ PCA 9539 16 bit GPIO expander. Datasheet: https://www.ti.com/lit/ds/symlink/pca
#define PCA_DIRECTION_0_REG 0x06
#define PCA_DIRECTION_1_REG 0x07

/**
* @brief Pointer to write function
*
*/
typedef int (*WritePtr)(uint16_t dev_addr, uint16_t mem_address,
uint16_t mem_add_size, uint8_t *data, uint16_t size,
int delay);

/**
* @brief Pointer to read function
*
*/
typedef int (*ReadPtr)(uint16_t dev_addr, uint16_t mem_address,
uint16_t mem_add_size, uint8_t *data, uint16_t size,
int delay);
Expand All @@ -49,32 +58,60 @@ typedef struct {
uint16_t dev_addr;
} pca9539_t;

void pca9539_init(pca9539_t *pca, WritePtr writeFunc, ReadPtr readFunc,
uint8_t dev_addr);
/**
* @brief Initialize the PCA9539 Driver
*
* @param pca
* @param writeFunc
* @param readFunc
* @param dev_addr
Copy link
Contributor

Choose a reason for hiding this comment

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

You should write what each of these mean, even if its completely obvious. Follow how doxygen comments are done in other codebases, like Cerb.

*/
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

void pca9539_init(pca9539_t *pca, WritePtr writeFunc, ReadPtr readFunc,
Copy link
Contributor

Choose a reason for hiding this comment

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

Doc comments are missing. Use doxygen, javadoc style comments seen in other repos.

uint8_t dev_addr);

int pca9539_read_reg(pca9539_t *pca, uint8_t reg_type, uint8_t *buf);
/**
* @brief Read the register of the PCA9539
*
* @param pca
* @param reg_type
* @param buf
* @return int
*/
int pca9539_read_reg(pca9539_t *pca, uint8_t reg_type, uint8_t *buf);

int pca9539_read_pin(pca9539_t *pca, uint8_t reg_type, uint8_t pin,
uint8_t *buf);
/**
* @brief Read the pin state of the PCA9539
*
* @param pca
* @param reg_type
* @param pin
* @param buf
* @return int
*/
int pca9539_read_pin(pca9539_t *pca, uint8_t reg_type, uint8_t pin,
uint8_t *buf);

int pca9539_write_reg(pca9539_t *pca, uint8_t reg_type, uint8_t buf);
/**

* @brief Write the register of the PCA9539
*
* @param pca
* @param reg_type
* @param buf
* @return int
*/
int pca9539_write_reg(pca9539_t *pca, uint8_t reg_type, uint8_t buf);

int pca9539_write_pin(pca9539_t *pca, uint8_t reg_type, uint8_t pin,
uint8_t buf);
/**
* @brief Write the pin of the PCA9539
*
* @param pca
* @param reg_type
* @param pin
* @param buf
* @return int
*/
int pca9539_write_pin(pca9539_t *pca, uint8_t reg_type, uint8_t pin,
uint8_t buf);

#endif
7 changes: 0 additions & 7 deletions general/src/pca9539.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

#define REG_SIZE_BITS 8

//Write Register returns the Write Function Pointer
int pca_write_reg(pca9539_t *pca, uint16_t address, uint8_t *data)
{
//Parameters in the HAL Function
Expand All @@ -16,7 +15,6 @@ int pca_write_reg(pca9539_t *pca, uint16_t address, uint8_t *data)
delay);
}

//Read Register returns the Read Function Pointer
int pca_read_reg(pca9539_t *pca, uint16_t address, uint8_t *data)
{
uint16_t mem_add_size = 8;
Expand All @@ -27,7 +25,6 @@ int pca_read_reg(pca9539_t *pca, uint16_t address, uint8_t *data)
delay);
}

//Intializes the struct
void pca9539_init(pca9539_t *pca, WritePtr writeFunc, ReadPtr readFunc,
uint8_t dev_addr)
{
Expand All @@ -37,7 +34,6 @@ void pca9539_init(pca9539_t *pca, WritePtr writeFunc, ReadPtr readFunc,
pca->read = readFunc;
}

//Read PCA9539 Register
int pca9539_read_reg(pca9539_t *pca, uint8_t reg_type, uint8_t *buf)
{
int status = pca_read_reg(pca, reg_type, buf);
Expand All @@ -48,7 +44,6 @@ int pca9539_read_reg(pca9539_t *pca, uint8_t reg_type, uint8_t *buf)
return status;
}

//Read PCA9539 Pin
int pca9539_read_pin(pca9539_t *pca, uint8_t reg_type, uint8_t pin,
uint8_t *buf)
{
Expand All @@ -63,13 +58,11 @@ int pca9539_read_pin(pca9539_t *pca, uint8_t reg_type, uint8_t pin,
return status;
}

//Write PCA9539 Register
int pca9539_write_reg(pca9539_t *pca, uint8_t reg_type, uint8_t buf)
{
return pca_write_reg(pca, reg_type, &buf);
}

//Write PCA9539 Pin
int pca9539_write_pin(pca9539_t *pca, uint8_t reg_type, uint8_t pin,
uint8_t buf)
{
Expand Down
Loading