Skip to content

fix: fix doc errors #8

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

Merged
libdriver merged 1 commit into from
Mar 14, 2025
Merged

fix: fix doc errors #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## 1.0.6 (2025-03-10)

## Bug Fixes

- fix doc errors

## 1.0.5 (2025-01-05)

## Bug Fixes
Expand Down
62 changes: 31 additions & 31 deletions project/raspberrypi4b/interface/inc/iic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ extern "C" {

/**
* @brief iic bus init
* @param[in] *name points to an iic device name buffer
* @param[out] *fd points to an iic device handle buffer
* @param[in] *name pointer to an iic device name buffer
* @param[out] *fd pointer to an iic device handle buffer
* @return status code
* - 0 success
* - 1 init failed
Expand All @@ -66,7 +66,7 @@ uint8_t iic_init(char *name, int *fd);

/**
* @brief iic bus deinit
* @param[in] fd is the iic handle
* @param[in] fd iic handle
* @return status code
* - 0 success
* - 1 deinit failed
Expand All @@ -76,10 +76,10 @@ uint8_t iic_deinit(int fd);

/**
* @brief iic bus read command
* @param[in] fd is the iic handle
* @param[in] addr is the iic device write address
* @param[out] *buf points to a data buffer
* @param[in] len is the length of the data buffer
* @param[in] fd iic handle
* @param[in] addr iic device write address
* @param[out] *buf pointer to a data buffer
* @param[in] len length of the data buffer
* @return status code
* - 0 success
* - 1 read failed
Expand All @@ -89,11 +89,11 @@ uint8_t iic_read_cmd(int fd, uint8_t addr, uint8_t *buf, uint16_t len);

/**
* @brief iic bus read
* @param[in] fd is the iic handle
* @param[in] addr is the iic device write address
* @param[in] reg is the iic register address
* @param[out] *buf points to a data buffer
* @param[in] len is the length of the data buffer
* @param[in] fd iic handle
* @param[in] addr iic device write address
* @param[in] reg iic register address
* @param[out] *buf pointer to a data buffer
* @param[in] len length of the data buffer
* @return status code
* - 0 success
* - 1 read failed
Expand All @@ -103,11 +103,11 @@ uint8_t iic_read(int fd, uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);

/**
* @brief iic bus read with 16 bits register address
* @param[in] fd is the iic handle
* @param[in] addr is the iic device write address
* @param[in] reg is the iic register address
* @param[out] *buf points to a data buffer
* @param[in] len is the length of the data buffer
* @param[in] fd iic handle
* @param[in] addr iic device write address
* @param[in] reg iic register address
* @param[out] *buf pointer to a data buffer
* @param[in] len length of the data buffer
* @return status code
* - 0 success
* - 1 read failed
Expand All @@ -117,10 +117,10 @@ uint8_t iic_read_address16(int fd, uint8_t addr, uint16_t reg, uint8_t *buf, uin

/**
* @brief iic bus write command
* @param[in] fd is the iic handle
* @param[in] addr is the iic device write address
* @param[in] *buf points to a data buffer
* @param[in] len is the length of the data buffer
* @param[in] fd iic handle
* @param[in] addr iic device write address
* @param[in] *buf pointer to a data buffer
* @param[in] len length of the data buffer
* @return status code
* - 0 success
* - 1 write failed
Expand All @@ -130,11 +130,11 @@ uint8_t iic_write_cmd(int fd, uint8_t addr, uint8_t *buf, uint16_t len);

/**
* @brief iic bus write
* @param[in] fd is the iic handle
* @param[in] addr is the iic device write address
* @param[in] reg is the iic register address
* @param[in] *buf points to a data buffer
* @param[in] len is the length of the data buffer
* @param[in] fd iic handle
* @param[in] addr iic device write address
* @param[in] reg iic register address
* @param[in] *buf pointer to a data buffer
* @param[in] len length of the data buffer
* @return status code
* - 0 success
* - 1 write failed
Expand All @@ -144,11 +144,11 @@ uint8_t iic_write(int fd, uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len)

/**
* @brief iic bus write with 16 bits register address
* @param[in] fd is the iic handle
* @param[in] addr is the iic device write address
* @param[in] reg is the iic register address
* @param[in] *buf points to a data buffer
* @param[in] len is the length of the data buffer
* @param[in] fd iic handle
* @param[in] addr iic device write address
* @param[in] reg iic register address
* @param[in] *buf pointer to a data buffer
* @param[in] len length of the data buffer
* @return status code
* - 0 success
* - 1 write failed
Expand Down
28 changes: 14 additions & 14 deletions project/raspberrypi4b/interface/inc/uart.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,12 @@ extern "C" {

/**
* @brief uart init
* @param[in] *name points to a device name buffer
* @param[out] *fd points to a uart handler buffer
* @param[in] baud_rate is the baud rate
* @param[in] data_bits is the data bits
* @param[in] parity is the data parity
* @param[in] stop_bits is the stop bits
* @param[in] *name pointer to a device name buffer
* @param[out] *fd pointer to a uart handler buffer
* @param[in] baud_rate baud rate
* @param[in] data_bits data bits
* @param[in] parity data parity
* @param[in] stop_bits stop bits
* @return status code
* - 0 success
* - 1 uart init failed
Expand All @@ -69,7 +69,7 @@ uint8_t uart_init(char *name, int *fd, uint32_t baud_rate, uint8_t data_bits, ch

/**
* @brief uart deinit
* @param[in] fd is the uart handle
* @param[in] fd uart handle
* @return status code
* - 0 success
* - 1 deinit failed
Expand All @@ -79,9 +79,9 @@ uint8_t uart_deinit(int fd);

/**
* @brief uart write data
* @param[in] fd is the uart handle
* @param[in] *buf points to a data buffer
* @param[in] len is the length of the data buffer
* @param[in] fd uart handle
* @param[in] *buf pointer to a data buffer
* @param[in] len length of the data buffer
* @return status code
* - 0 success
* - 1 write failed
Expand All @@ -91,9 +91,9 @@ uint8_t uart_write(int fd, uint8_t *buf, uint32_t len);

/**
* @brief uart read data
* @param[in] fd is the uart handle
* @param[out] *buf points to a data buffer
* @param[in, out] *len points to a length of the data buffer
* @param[in] fd uart handle
* @param[out] *buf pointer to a data buffer
* @param[in, out] *len pointer to a length of the data buffer
* @return status code
* - 0 success
* - 1 read failed
Expand All @@ -103,7 +103,7 @@ uint8_t uart_read(int fd, uint8_t *buf, uint32_t *len);

/**
* @brief uart flush
* @param[in] fd is the uart handle
* @param[in] fd uart handle
* @return status code
* - 0 success
* - 1 flush failed
Expand Down
62 changes: 31 additions & 31 deletions project/raspberrypi4b/interface/src/iic.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@

/**
* @brief iic bus init
* @param[in] *name points to an iic device name buffer
* @param[out] *fd points to an iic device handle buffer
* @param[in] *name pointer to an iic device name buffer
* @param[out] *fd pointer to an iic device handle buffer
* @return status code
* - 0 success
* - 1 init failed
Expand All @@ -69,7 +69,7 @@ uint8_t iic_init(char *name, int *fd)

/**
* @brief iic bus deinit
* @param[in] fd is the iic handle
* @param[in] fd iic handle
* @return status code
* - 0 success
* - 1 deinit failed
Expand All @@ -92,10 +92,10 @@ uint8_t iic_deinit(int fd)

/**
* @brief iic bus read command
* @param[in] fd is the iic handle
* @param[in] addr is the iic device write address
* @param[out] *buf points to a data buffer
* @param[in] len is the length of the data buffer
* @param[in] fd iic handle
* @param[in] addr iic device write address
* @param[out] *buf pointer to a data buffer
* @param[in] len length of the data buffer
* @return status code
* - 0 success
* - 1 read failed
Expand Down Expand Up @@ -133,11 +133,11 @@ uint8_t iic_read_cmd(int fd, uint8_t addr, uint8_t *buf, uint16_t len)

/**
* @brief iic bus read
* @param[in] fd is the iic handle
* @param[in] addr is the iic device write address
* @param[in] reg is the iic register address
* @param[out] *buf points to a data buffer
* @param[in] len is the length of the data buffer
* @param[in] fd iic handle
* @param[in] addr iic device write address
* @param[in] reg iic register address
* @param[out] *buf pointer to a data buffer
* @param[in] len length of the data buffer
* @return status code
* - 0 success
* - 1 read failed
Expand Down Expand Up @@ -179,11 +179,11 @@ uint8_t iic_read(int fd, uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len)

/**
* @brief iic bus read with 16 bits register address
* @param[in] fd is the iic handle
* @param[in] addr is the iic device write address
* @param[in] reg is the iic register address
* @param[out] *buf points to a data buffer
* @param[in] len is the length of the data buffer
* @param[in] fd iic handle
* @param[in] addr iic device write address
* @param[in] reg iic register address
* @param[out] *buf pointer to a data buffer
* @param[in] len length of the data buffer
* @return status code
* - 0 success
* - 1 read failed
Expand Down Expand Up @@ -228,10 +228,10 @@ uint8_t iic_read_address16(int fd, uint8_t addr, uint16_t reg, uint8_t *buf, uin

/**
* @brief iic bus write command
* @param[in] fd is the iic handle
* @param[in] addr is the iic device write address
* @param[in] *buf points to a data buffer
* @param[in] len is the length of the data buffer
* @param[in] fd iic handle
* @param[in] addr iic device write address
* @param[in] *buf pointer to a data buffer
* @param[in] len length of the data buffer
* @return status code
* - 0 success
* - 1 write failed
Expand Down Expand Up @@ -269,11 +269,11 @@ uint8_t iic_write_cmd(int fd, uint8_t addr, uint8_t *buf, uint16_t len)

/**
* @brief iic bus write
* @param[in] fd is the iic handle
* @param[in] addr is the iic device write address
* @param[in] reg is the iic register address
* @param[in] *buf points to a data buffer
* @param[in] len is the length of the data buffer
* @param[in] fd iic handle
* @param[in] addr iic device write address
* @param[in] reg iic register address
* @param[in] *buf pointer to a data buffer
* @param[in] len length of the data buffer
* @return status code
* - 0 success
* - 1 write failed
Expand Down Expand Up @@ -317,11 +317,11 @@ uint8_t iic_write(int fd, uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len)

/**
* @brief iic bus write with 16 bits register address
* @param[in] fd is the iic handle
* @param[in] addr is the iic device write address
* @param[in] reg is the iic register address
* @param[in] *buf points to a data buffer
* @param[in] len is the length of the data buffer
* @param[in] fd iic handle
* @param[in] addr iic device write address
* @param[in] reg iic register address
* @param[in] *buf pointer to a data buffer
* @param[in] len length of the data buffer
* @return status code
* - 0 success
* - 1 write failed
Expand Down
38 changes: 19 additions & 19 deletions project/raspberrypi4b/interface/src/uart.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@

/**
* @brief uart config
* @param[in] fd is the uart handler
* @param[in] baud_rate is the baud rate
* @param[in] data_bits is the data bits
* @param[in] parity is the data parity
* @param[in] stop_bits is the stop bits
* @param[in] fd uart handler
* @param[in] baud_rate baud rate
* @param[in] data_bits data bits
* @param[in] parity data parity
* @param[in] stop_bits stop bits
* @return status code
* - 0 success
* - 1 set config failed
Expand Down Expand Up @@ -297,12 +297,12 @@ static uint8_t a_uart_config(int fd, uint32_t baud_rate, uint8_t data_bits, char

/**
* @brief uart init
* @param[in] *name points to a device name buffer
* @param[out] *fd points to a uart handler buffer
* @param[in] baud_rate is the baud rate
* @param[in] data_bits is the data bits
* @param[in] parity is the data parity
* @param[in] stop_bits is the stop bits
* @param[in] *name pointer to a device name buffer
* @param[out] *fd pointer to a uart handler buffer
* @param[in] baud_rate baud rate
* @param[in] data_bits data bits
* @param[in] parity data parity
* @param[in] stop_bits stop bits
* @return status code
* - 0 success
* - 1 uart init failed
Expand Down Expand Up @@ -332,7 +332,7 @@ uint8_t uart_init(char *name, int *fd, uint32_t baud_rate, uint8_t data_bits, ch

/**
* @brief uart deinit
* @param[in] fd is the uart handle
* @param[in] fd uart handle
* @return status code
* - 0 success
* - 1 deinit failed
Expand All @@ -355,9 +355,9 @@ uint8_t uart_deinit(int fd)

/**
* @brief uart write data
* @param[in] fd is the uart handle
* @param[in] *buf points to a data buffer
* @param[in] len is the length of the data buffer
* @param[in] fd uart handle
* @param[in] *buf pointer to a data buffer
* @param[in] len length of the data buffer
* @return status code
* - 0 success
* - 1 write failed
Expand All @@ -380,9 +380,9 @@ uint8_t uart_write(int fd, uint8_t *buf, uint32_t len)

/**
* @brief uart read data
* @param[in] fd is the uart handle
* @param[out] *buf points to a data buffer
* @param[in, out] *len points to a length of the data buffer
* @param[in] fd uart handle
* @param[out] *buf pointer to a data buffer
* @param[in, out] *len pointer to a length of the data buffer
* @return status code
* - 0 success
* - 1 read failed
Expand Down Expand Up @@ -411,7 +411,7 @@ uint8_t uart_read(int fd, uint8_t *buf, uint32_t *len)

/**
* @brief uart flush
* @param[in] fd is the uart handle
* @param[in] fd uart handle
* @return status code
* - 0 success
* - 1 flush failed
Expand Down
Loading