search

Microchip-MPLAB-Harmony / csp

Harmony 3 Chip Support Package
https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MH3_csp&redirect=true
Other
34 stars 22 forks source link

SPI Library Documentation #30

Closed michaelidesmi closed 3 years ago

michaelidesmi commented 3 years ago

I've noticed 2 minor documentation issues for the SPI Peripheral Library. I am using a PIC32MZ.

In the SPIx_WriteRead documentation it is stated that It returns False if either of the size parameters are 0 and corresponding data pointer is NULL. which is not accurate. The function will return false if both size parameters are 0.

In the SPIx_TransferSetup there is no mention of the fact that for the spiSourceClock a value of 0 will default to Use Master Clock Frequency set in GUI. If this is something that will become obsolete in the future ignore it.

vishalnxt commented 3 years ago

@michaelidesmi , thank you for bringing the issues to our notice. We will update the documentation in the next release.

vishalnxt commented 3 years ago

@michaelidesmi , the issue is fixed in v3.10 release. I am closing the ticket. Feel free to re-open it in case you find any issues.