Skip to content

Commit 7ca9103

Browse files
committed
add comment on ReconfigSPI usage
1 parent fce81e0 commit 7ca9103

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

firmware/driver/inc/ShiftRegister_SPI.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,9 @@ void SR_SPI_Deassert_AllOff(ShiftRegister_SPI_HandleTypeDef* sr);
7676
/**
7777
* @brief Reconfigures SPI before communicating with device, for if multiple
7878
* devices on the same SPI bus require different settings. Weakly
79-
* defined.
79+
* defined. Should NOT be called outside of driver or could disrupt
80+
* communications with other devices. (Driver only calls once SPI
81+
* mutex is taken.)
8082
* @param device Shift Register Device Handle
8183
* @returns bool (true if successful)
8284
*/

0 commit comments

Comments
 (0)