sci_handshaking.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef SCI_HANDSHAKING_H
#define SCI_HANDSHAKING_H
/*!***************************************************************************
 * @defgroup    sci_handshaking SCI: Handshaking
 * @ingroup     sci
 * @brief       SCI Handshaking Module
 * @details     Implements the handshaking command messages:
 *               - Acknowledge
 *               - Not-Acknowledge
 *               .
 * @addtogroup  sci_handshaking
 * @{
 *****************************************************************************/
 
#include "sci.h"
 
 
/*!***************************************************************************
 * @brief   Sends an Acknowledge message.
 * @param   deviceID The ID (index) of the SPI device that should process
 *          the received frame.
 *          This is only used for extended commands!
 * @param   cmd The command that is acknowledged.
 *          If extended command is passed, the frame will contain the deviceID.
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t SCI_SendAcknowledge(sci_device_t deviceID, sci_cmd_t cmd);
 
/*!***************************************************************************
 * @brief   Sends an Not-Acknowledge message.
 * @param   deviceID The ID (index) of the SPI device that should process
 *          the received frame.
 *          This is only used for extended commands!
 * @param   cmd The command that is not-acknowledged.
 *          If extended command is passed, the frame will contain the deviceID.
 * @param   reason The reason/status that caused the not-acknowledged.
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t SCI_SendNotAcknowledge(sci_device_t deviceID, sci_cmd_t cmd, status_t reason);
 
 
#endif // SCI_HANDSHAKING_H