Skip to content

Commit 9526dad

Browse files
authored
Merge pull request #11691 from kyle-cypress/pr/qspi-no-inst
QSPI: document use of QSPI_NO_INST
2 parents 83207ae + 27dc79a commit 9526dad

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

drivers/QSPI.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ class QSPI : private NonCopyable<QSPI> {
157157

158158
/** Read from QSPI peripheral using custom read instruction, alt values
159159
*
160-
* @param instruction Instruction value to be used in instruction phase
160+
* @param instruction Instruction value to be used in instruction phase. Use QSPI_NO_INST to skip the instruction phase
161161
* @param alt Alt value to be used in Alternate-byte phase. Use -1 for ignoring Alternate-byte phase
162162
* @param address Address to be accessed in QSPI peripheral
163163
* @param rx_buffer Buffer for data to be read from the peripheral
@@ -170,7 +170,7 @@ class QSPI : private NonCopyable<QSPI> {
170170

171171
/** Write to QSPI peripheral using custom write instruction, alt values
172172
*
173-
* @param instruction Instruction value to be used in instruction phase
173+
* @param instruction Instruction value to be used in instruction phase. Use QSPI_NO_INST to skip the instruction phase
174174
* @param alt Alt value to be used in Alternate-byte phase. Use -1 for ignoring Alternate-byte phase
175175
* @param address Address to be accessed in QSPI peripheral
176176
* @param tx_buffer Buffer containing data to be sent to peripheral
@@ -183,7 +183,7 @@ class QSPI : private NonCopyable<QSPI> {
183183

184184
/** Perform a transaction to write to an address(a control register) and get the status results
185185
*
186-
* @param instruction Instruction value to be used in instruction phase
186+
* @param instruction Instruction value to be used in instruction phase. Use QSPI_NO_INST to skip the instruction phase
187187
* @param address Some instruction might require address. Use -1 if no address
188188
* @param tx_buffer Buffer containing data to be sent to peripheral
189189
* @param tx_length Pointer to a variable containing the length of data to be transmitted, and on return this variable will be updated with the actual number of bytes written

0 commit comments

Comments
 (0)