Skip to content

Commit 5cc18dc

Browse files
committed
add doc/comment
1 parent 1273713 commit 5cc18dc

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/sfTk/sfDevFPC2534IComm.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,15 @@ class sfDevFPC2534IComm
2323
virtual void clearData(void) = 0;
2424
virtual uint16_t write(const uint8_t *data, size_t len) = 0;
2525
virtual uint16_t read(uint8_t *data, size_t len) = 0;
26+
2627
// On SPI writes, the CS line needs to remain low during writes (which have multiple blocks).
2728
// So add a normally no-op beginWrite and endWrite methods that can be overridden by SPI comm classes.
2829
virtual void beginWrite(void) {};
2930
virtual void endWrite(void) {};
3031

32+
// For SPI read, multiple reads for the same transaction need to be bracketed with the Arduino transaction
33+
// calls and the CS pin needs to remain low. So again, we add normally no-op beginRead and endRead methods
34+
// that can be overridden by SPI comm classes. This keeps the main library code clean and simple.
3135
virtual void beginRead(void) {};
3236
virtual void endRead(void) {};
3337

0 commit comments

Comments
 (0)