AFBR-S50 API Reference Manual  v1.6.5
AFBR-S50 Time-of-Flight Sensor SDK for Embedded Software
sci_handshaking.h
Go to the documentation of this file.
1 /*************************************************************************/
38 #ifndef SCI_HANDSHAKING_H
39 #define SCI_HANDSHAKING_H
40 /*!***************************************************************************
41  * @defgroup sci_handshaking SCI: Handshaking
42  * @ingroup sci
43  * @brief SCI Handshaking Module
44  * @details Implements the handshaking command messages:
45  * - Acknowledge
46  * - Not-Acknowledge
47  * .
48  * @addtogroup sci_handshaking
49  * @{
50  *****************************************************************************/
51 
52 #include "sci.h"
53 
54 
55 /*!***************************************************************************
56  * @brief Sends an Acknowledge message.
57  * @param deviceID The ID (index) of the SPI device that should process
58  * the received frame.
59  * This is only used for extended commands!
60  * @param cmd The command that is acknowledged.
61  * If extended command is passed, the frame will contain the deviceID.
62  * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
63  *****************************************************************************/
64 status_t SCI_SendAcknowledge(sci_device_t deviceID, sci_cmd_t cmd);
65 
66 /*!***************************************************************************
67  * @brief Sends an Not-Acknowledge message.
68  * @param deviceID The ID (index) of the SPI device that should process
69  * the received frame.
70  * This is only used for extended commands!
71  * @param cmd The command that is not-acknowledged.
72  * If extended command is passed, the frame will contain the deviceID.
73  * @param reason The reason/status that caused the not-acknowledged.
74  * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
75  *****************************************************************************/
76 status_t SCI_SendNotAcknowledge(sci_device_t deviceID, sci_cmd_t cmd, status_t reason);
77 
78 
80 #endif // SCI_HANDSHAKING_H
sci_device_t
uint8_t sci_device_t
Definition: sci.h:99
sci.h
SCI: The main interface.
SCI_SendNotAcknowledge
status_t SCI_SendNotAcknowledge(sci_device_t deviceID, sci_cmd_t cmd, status_t reason)
Sends an Not-Acknowledge message.
Definition: sci_handshaking.c:84
sci_cmd_t
uint8_t sci_cmd_t
Definition: sci.h:81
SCI_SendAcknowledge
status_t SCI_SendAcknowledge(sci_device_t deviceID, sci_cmd_t cmd)
Sends an Acknowledge message.
Definition: sci_handshaking.c:65
status_t
int32_t status_t
Type used for all status and error return values.
Definition: argus_status.h:70