search

STMicroelectronics / iis3dwb-pid

iis3dwb platform independent driver based on Standard C language and compliant with MISRA standard
BSD 3-Clause "New" or "Revised" License
12 stars 9 forks source link

Typo in iis3dwb_fifo_status_get #11

Closed escherstair closed 1 year ago

escherstair commented 1 year ago

I think that the documentation of iis3dwb_fifo_status_get has a little typo. After commit f19da2b it reads both FIFO_STATUS1 and FIFO_STATUS2 registers https://github.com/STMicroelectronics/iis3dwb-pid/blob/b85e3d23bbc5806011dd202a528308099cb24204/iis3dwb_reg.c#L3129 and combines their content into the struct iis3dwb_fifo_status_t.

I suggest to change https://github.com/STMicroelectronics/iis3dwb-pid/blob/b85e3d23bbc5806011dd202a528308099cb24204/iis3dwb_reg.c#L3118 into * @param val Registers FIFO_STATUS1 and FIFO_STATUS2

escherstair commented 1 year ago

Fixed with commit https://github.com/STMicroelectronics/iis3dwb-pid/commit/6c2665bf0c7a632cc38d30a5c1a253cf6b873d6d