mirror of
https://github.com/espressif/openthread.git
synced 2026-08-29 13:29:54 +00:00
Update formatting in NcpSpi and spi-slave.h files (#1648)
This commit contains node logic change. It makes some formatting changes in the comments, also renames method/function argument/param variable names to follow the style guideline (e.g., `anInputBuf -> aInputBuf`).
This commit is contained in:
Abtin Keshavarzian
committed by
Jonathan Hui
Jonathan Hui
parent
25eb3debd3
commit
0d9e403286
@@ -36,10 +36,7 @@
|
||||
|
||||
// Spi-slave stubs
|
||||
|
||||
ThreadError otPlatSpiSlaveEnable(
|
||||
otPlatSpiSlaveTransactionCompleteCallback aCallback,
|
||||
void *aContext
|
||||
)
|
||||
ThreadError otPlatSpiSlaveEnable(otPlatSpiSlaveTransactionCompleteCallback aCallback, void *aContext)
|
||||
{
|
||||
(void)aCallback;
|
||||
(void)aContext;
|
||||
@@ -54,18 +51,13 @@ void otPlatSpiSlaveDisable(void)
|
||||
{
|
||||
}
|
||||
|
||||
ThreadError otPlatSpiSlavePrepareTransaction(
|
||||
uint8_t *anOutputBuf,
|
||||
uint16_t anOutputBufLen,
|
||||
uint8_t *anInputBuf,
|
||||
uint16_t anInputBufLen,
|
||||
bool aRequestTransactionFlag
|
||||
)
|
||||
ThreadError otPlatSpiSlavePrepareTransaction(uint8_t *aOutputBuf, uint16_t aOutputBufLen, uint8_t *aInputBuf,
|
||||
uint16_t aInputBufLen, bool aRequestTransactionFlag)
|
||||
{
|
||||
(void)anOutputBuf;
|
||||
(void)anOutputBufLen;
|
||||
(void)anInputBuf;
|
||||
(void)anInputBufLen;
|
||||
(void)aOutputBuf;
|
||||
(void)aOutputBufLen;
|
||||
(void)aInputBuf;
|
||||
(void)aInputBufLen;
|
||||
(void)aRequestTransactionFlag;
|
||||
|
||||
return kThreadError_NotImplemented;
|
||||
|
||||
@@ -55,62 +55,45 @@ extern "C" {
|
||||
*/
|
||||
|
||||
/**
|
||||
* Indicates that a SPI transaction has completed with
|
||||
* the given length. The data written to the slave has been
|
||||
* written to the pointer indicated by the `anInputBuf` argument
|
||||
* to the previous call to otPlatSpiSlavePrepareTransaction().
|
||||
* Indicates that a SPI transaction has completed with the given length. The data written to the slave has been written
|
||||
* to the pointer indicated by the `aInputBuf` argument to the previous call to `otPlatSpiSlavePrepareTransaction()`.
|
||||
*
|
||||
* Once this function is called, otPlatSpiSlavePrepareTransaction()
|
||||
* is invalid and must be called again for the next transaction to be
|
||||
* valid.
|
||||
* Once this function is called, `otPlatSpiSlavePrepareTransaction()` is invalid and must be called again for the next
|
||||
* transaction to be valid.
|
||||
*
|
||||
* Note that this function is always called at the end of a transaction,
|
||||
* even if otPlatSpiSlavePrepareTransaction() has not yet been called.
|
||||
* In such cases, anOutputBufLen and anInputBufLen will be zero.
|
||||
* Note that this function is always called at the end of a transaction, even if `otPlatSpiSlavePrepareTransaction()`
|
||||
* has not yet been called. In such cases, `aOutputBufLen` and `aInputBufLen` will be zero.
|
||||
*
|
||||
* @param[in] aContext Context pointer passed into `otPlatSpiSlaveEnable()`.
|
||||
* @param[in] aOutputBuf Value of `aOutputBuf` from last call to `otPlatSpiSlavePrepareTransaction()`.
|
||||
* @param[in] aOutputBufLen Value of `aOutputBufLen` from last call to `otPlatSpiSlavePrepareTransaction()`.
|
||||
* @param[in] aInputBuf Value of aInputBuf from last call to `otPlatSpiSlavePrepareTransaction()`.
|
||||
* @param[in] aInputBufLen Value of aInputBufLen from last call to `otPlatSpiSlavePrepareTransaction()`
|
||||
* @param[in] aTransactionLength Length of the completed transaction, in bytes.
|
||||
*
|
||||
* @param[in] aContext Context pointer passed into
|
||||
* otPlatSpiSlaveEnable()
|
||||
* @param[in] anOutputBuf Value of anOutputBuf from last call to
|
||||
* otPlatSpiSlavePrepareTransaction()
|
||||
* @param[in] anOutputBufLen Value of anOutputBufLen from last call to
|
||||
* otPlatSpiSlavePrepareTransaction()
|
||||
* @param[in] anInputBuf Value of anInputBuf from last call to
|
||||
* otPlatSpiSlavePrepareTransaction()
|
||||
* @param[in] anInputBufLen Value of anInputBufLen from last call to
|
||||
* otPlatSpiSlavePrepareTransaction()
|
||||
* @param[in] aTransactionLength Length of the completed transaction, in bytes
|
||||
*/
|
||||
typedef void (*otPlatSpiSlaveTransactionCompleteCallback)(
|
||||
void *aContext,
|
||||
uint8_t *anOutputBuf,
|
||||
uint16_t anOutputBufLen,
|
||||
uint8_t *anInputBuf,
|
||||
uint16_t anInputBufLen,
|
||||
uint16_t aTransactionLength
|
||||
);
|
||||
typedef void (*otPlatSpiSlaveTransactionCompleteCallback)(void *aContext, uint8_t *aOutputBuf, uint16_t aOutputBufLen,
|
||||
uint8_t *aInputBuf, uint16_t aInputBufLen,
|
||||
uint16_t aTransactionLength);
|
||||
|
||||
|
||||
/**
|
||||
* Initialize the SPI slave interface.
|
||||
|
||||
* Note that the SPI slave is not fully ready until a transaction is
|
||||
* prepared using otPlatSPISlavePrepareTransaction().
|
||||
* Note that SPI slave is not fully ready until a transaction is prepared using `otPlatSPISlavePrepareTransaction()`.
|
||||
*
|
||||
* If otPlatSPISlavePrepareTransaction() is not called before
|
||||
* the master begins a transaction, the resulting SPI transaction
|
||||
* will send all `0xFF` bytes and discard all received bytes.
|
||||
* If `otPlatSPISlavePrepareTransaction() is not called before the master begins a transaction, the resulting SPI
|
||||
* transaction will send all `0xFF` bytes and discard all received bytes.
|
||||
*
|
||||
* @param[in] aCallback Pointer to transaction complete callback
|
||||
* @param[in] aContext Context pointer to be passed to transaction
|
||||
* complete callback
|
||||
* @param[in] aCallback Pointer to transaction complete callback.
|
||||
* @param[in] aContext Context pointer to be passed to transaction complete callback.
|
||||
*
|
||||
* @retval kThreadError_None Successfully enabled the SPI Slave interface.
|
||||
* @retval kThreadError_Already SPI Slave interface is already enabled.
|
||||
* @retval kThreadError_Failed Failed to enable the SPI Slave interface.
|
||||
*
|
||||
* @retval ::kThreadError_None Successfully enabled the SPI Slave interface.
|
||||
* @retval ::kThreadError_Already SPI Slave interface is already enabled.
|
||||
* @retval ::kThreadError_Failed Failed to enable the SPI Slave interface.
|
||||
*/
|
||||
ThreadError otPlatSpiSlaveEnable(
|
||||
otPlatSpiSlaveTransactionCompleteCallback aCallback,
|
||||
void *aContext
|
||||
);
|
||||
ThreadError otPlatSpiSlaveEnable(otPlatSpiSlaveTransactionCompleteCallback aCallback, void *aContext);
|
||||
|
||||
/**
|
||||
* Shutdown and disable the SPI slave interface.
|
||||
@@ -118,58 +101,43 @@ ThreadError otPlatSpiSlaveEnable(
|
||||
void otPlatSpiSlaveDisable(void);
|
||||
|
||||
/**
|
||||
* Prepare data for the next SPI transaction. Data pointers
|
||||
* MUST remain valid until the transaction complete callback
|
||||
* is called by the SPI slave driver, or until after the
|
||||
* next call to otPlatSpiSlavePrepareTransaction().
|
||||
* Prepare data for the next SPI transaction. Data pointers MUST remain valid until the transaction complete callback
|
||||
* is called by the SPI slave driver, or until after the next call to `otPlatSpiSlavePrepareTransaction()`.
|
||||
*
|
||||
* This function may be called more than once before the SPI
|
||||
* master initiates the transaction. Each *successful* call to this
|
||||
* function will cause the previous values from earlier calls to
|
||||
* be discarded.
|
||||
* This function may be called more than once before the SPI master initiates the transaction. Each *successful* call
|
||||
* to this function will cause the previous values from earlier calls to be discarded.
|
||||
*
|
||||
* Not calling this function after a completed transaction is the
|
||||
* same as if this function was previously called with both buffer
|
||||
* lengths set to zero and aRequestTransactionFlag set to `false`.
|
||||
* Not calling this function after a completed transaction is the same as if this function was previously called with
|
||||
* both buffer lengths set to zero and `aRequestTransactionFlag` set to `false`.
|
||||
*
|
||||
* Once anOutputBufLen bytes of anOutputBuf has been clocked out, the
|
||||
* MISO pin shall be set high until the master finishes the SPI
|
||||
* transaction. This is the functional equivalent of padding the end
|
||||
* of anOutputBuf with 0xFF bytes out to the length of the transaction.
|
||||
* Once `aOutputBufLen` bytes of `aOutputBuf` has been clocked out, the MISO pin shall be set high until the master
|
||||
* finishes the SPI transaction. This is the functional equivalent of padding the end of `aOutputBuf` with `0xFF` bytes
|
||||
* out to the length of the transaction.
|
||||
*
|
||||
* Once anInputBufLen bytes of anInputBuf have been clocked in from
|
||||
* MOSI, all subsequent values from the MOSI pin are ignored until the
|
||||
* SPI master finishes the transaction.
|
||||
* Once `aInputBufLen` bytes of aInputBuf have been clocked in from MOSI, all subsequent values from the MOSI pin are
|
||||
* ignored until the SPI master finishes the transaction.
|
||||
*
|
||||
* Note that even if `anInputBufLen` or `anOutputBufLen` (or both) are
|
||||
* exhausted before the SPI master finishes a transaction, the ongoing
|
||||
* size of the transaction must still be kept track of to be passed
|
||||
* to the transaction complete callback. For example, if `anInputBufLen`
|
||||
* is equal to 10 and `anOutputBufLen` equal to 20 and the SPI master
|
||||
* clocks out 30 bytes, the value 30 is passed to the transaction
|
||||
* complete callback.
|
||||
* Note that even if `aInputBufLen` or `aOutputBufLen` (or both) are exhausted before the SPI master finishes a
|
||||
* transaction, the ongoing size of the transaction must still be kept track of to be passed to the transaction complete
|
||||
* callback. For example, if `aInputBufLen` is equal to 10 and `aOutputBufLen` equal to 20 and the SPI master clocks out
|
||||
* 30 bytes, the value 30 is passed to the transaction complete callback.
|
||||
*
|
||||
* Any call to this function while a transaction is in progress will
|
||||
* cause all of the arguments to be ignored and the return value to
|
||||
* be ::kThreadError_Busy.
|
||||
* Any call to this function while a transaction is in progress will cause all of the arguments to be ignored and the
|
||||
* return value to be `kThreadError_Busy`.
|
||||
*
|
||||
* @param[in] anOutputBuf Data to be written to MISO pin
|
||||
* @param[in] anOutputBufLen Size of the output buffer, in bytes
|
||||
* @param[in] anInputBuf Data to be read from MOSI pin
|
||||
* @param[in] anInputBufLen Size of the input buffer, in bytes
|
||||
* @param[in] aOutputBuf Data to be written to MISO pin
|
||||
* @param[in] aOutputBufLen Size of the output buffer, in bytes
|
||||
* @param[in] aInputBuf Data to be read from MOSI pin
|
||||
* @param[in] aInputBufLen Size of the input buffer, in bytes
|
||||
* @param[in] aRequestTransactionFlag Set to true if host interrupt should be set
|
||||
*
|
||||
* @retval ::kThreadError_None Transaction was successfully prepared.
|
||||
* @retval ::kThreadError_Busy A transaction is currently in progress.
|
||||
* @retval ::kThreadError_InvalidState otPlatSpiSlaveEnable() hasn't been called.
|
||||
* @retval kThreadError_None Transaction was successfully prepared.
|
||||
* @retval kThreadError_Busy A transaction is currently in progress.
|
||||
* @retval kThreadError_InvalidState otPlatSpiSlaveEnable() hasn't been called.
|
||||
*
|
||||
*/
|
||||
ThreadError otPlatSpiSlavePrepareTransaction(
|
||||
uint8_t *anOutputBuf,
|
||||
uint16_t anOutputBufLen,
|
||||
uint8_t *anInputBuf,
|
||||
uint16_t anInputBufLen,
|
||||
bool aRequestTransactionFlag
|
||||
);
|
||||
ThreadError otPlatSpiSlavePrepareTransaction(uint8_t *aOutputBuf, uint16_t aOutputBufLen, uint8_t *aInputBuf,
|
||||
uint16_t aInputBufLen, bool aRequestTransactionFlag);
|
||||
|
||||
/**
|
||||
* @}
|
||||
|
||||
+11
-45
@@ -117,42 +117,19 @@ NcpSpi::NcpSpi(otInstance *aInstance):
|
||||
// We signal an interrupt on this first transaction to
|
||||
// make sure that the host processor knows that our
|
||||
// reset flag was set.
|
||||
otPlatSpiSlavePrepareTransaction(
|
||||
mEmptySendFrame,
|
||||
kSpiHeaderLength,
|
||||
mEmptyReceiveFrame,
|
||||
kSpiHeaderLength,
|
||||
true
|
||||
);
|
||||
otPlatSpiSlavePrepareTransaction(mEmptySendFrame, kSpiHeaderLength, mEmptyReceiveFrame, kSpiHeaderLength, true);
|
||||
}
|
||||
|
||||
void
|
||||
NcpSpi::SpiTransactionComplete(
|
||||
void *aContext,
|
||||
uint8_t *anOutputBuf,
|
||||
uint16_t anOutputBufLen,
|
||||
uint8_t *anInputBuf,
|
||||
uint16_t anInputBufLen,
|
||||
uint16_t aTransactionLength
|
||||
)
|
||||
void NcpSpi::SpiTransactionComplete(void *aContext, uint8_t *anOutputBuf, uint16_t aOutputBufLen, uint8_t *aInputBuf,
|
||||
uint16_t aInputBufLen, uint16_t aTransactionLength)
|
||||
{
|
||||
static_cast<NcpSpi*>(aContext)->SpiTransactionComplete(
|
||||
anOutputBuf,
|
||||
anOutputBufLen,
|
||||
anInputBuf,
|
||||
anInputBufLen,
|
||||
aTransactionLength
|
||||
);
|
||||
static_cast<NcpSpi*>(aContext)->SpiTransactionComplete(anOutputBuf, aOutputBufLen, aInputBuf, aInputBufLen,
|
||||
aTransactionLength);
|
||||
}
|
||||
|
||||
void
|
||||
NcpSpi::SpiTransactionComplete(
|
||||
uint8_t *aMISOBuf,
|
||||
uint16_t aMISOBufLen,
|
||||
uint8_t *aMOSIBuf,
|
||||
uint16_t aMOSIBufLen,
|
||||
uint16_t aTransactionLength
|
||||
) {
|
||||
void NcpSpi::SpiTransactionComplete(uint8_t *aMISOBuf, uint16_t aMISOBufLen, uint8_t *aMOSIBuf, uint16_t aMOSIBufLen,
|
||||
uint16_t aTransactionLength)
|
||||
{
|
||||
// This may be executed from an interrupt context.
|
||||
// Must return as quickly as possible.
|
||||
|
||||
@@ -232,13 +209,7 @@ NcpSpi::SpiTransactionComplete(
|
||||
spi_header_set_accept_len(aMISOBuf, sizeof(mReceiveFrame) - kSpiHeaderLength);
|
||||
}
|
||||
|
||||
otPlatSpiSlavePrepareTransaction(
|
||||
aMISOBuf,
|
||||
aMISOBufLen,
|
||||
aMOSIBuf,
|
||||
aMOSIBufLen,
|
||||
(mTxState == kTxStateSending)
|
||||
);
|
||||
otPlatSpiSlavePrepareTransaction(aMISOBuf, aMISOBufLen, aMOSIBuf, aMOSIBufLen, (mTxState == kTxStateSending));
|
||||
}
|
||||
|
||||
void NcpSpi::TxFrameBufferHasData(void *aContext, NcpFrameBuffer *aNcpFrameBuffer)
|
||||
@@ -278,13 +249,8 @@ ThreadError NcpSpi::PrepareNextSpiSendFrame(void)
|
||||
|
||||
mTxState = kTxStateSending;
|
||||
|
||||
errorCode = otPlatSpiSlavePrepareTransaction(
|
||||
mSendFrame,
|
||||
mSendFrameLen,
|
||||
mEmptyReceiveFrame,
|
||||
sizeof(mEmptyReceiveFrame),
|
||||
true
|
||||
);
|
||||
errorCode = otPlatSpiSlavePrepareTransaction(mSendFrame, mSendFrameLen, mEmptyReceiveFrame,
|
||||
sizeof(mEmptyReceiveFrame), true);
|
||||
|
||||
if (errorCode == kThreadError_Busy)
|
||||
{
|
||||
|
||||
+4
-15
@@ -75,21 +75,10 @@ private:
|
||||
|
||||
uint16_t OutboundFrameSize(void);
|
||||
|
||||
static void SpiTransactionComplete(
|
||||
void *context,
|
||||
uint8_t *anOutputBuf,
|
||||
uint16_t anOutputBufLen,
|
||||
uint8_t *anInputBuf,
|
||||
uint16_t anInputBufLen,
|
||||
uint16_t aTransactionLength
|
||||
);
|
||||
void SpiTransactionComplete(
|
||||
uint8_t *anOutputBuf,
|
||||
uint16_t anOutputBufLen,
|
||||
uint8_t *anInputBuf,
|
||||
uint16_t anInputBufLen,
|
||||
uint16_t aTransactionLength
|
||||
);
|
||||
static void SpiTransactionComplete(void *context, uint8_t *aOutputBuf, uint16_t aOutputBufLen, uint8_t *aInputBuf,
|
||||
uint16_t aInputBufLen, uint16_t aTransactionLength);
|
||||
void SpiTransactionComplete(uint8_t *aOutputBuf, uint16_t aOutputBufLen, uint8_t *aInputBuf, uint16_t aInputBufLen,
|
||||
uint16_t aTransactionLength);
|
||||
|
||||
static void HandleRxFrame(void *context);
|
||||
void HandleRxFrame(void);
|
||||
|
||||
Reference in New Issue
Block a user