--- a/master/foe.h Thu Sep 06 14:21:02 2012 +0200
+++ b/master/foe.h Mon Nov 03 15:20:05 2014 +0100
@@ -27,28 +27,34 @@
*
*****************************************************************************/
+/** \file
+ * FoE defines.
+ */
+
#ifndef __FOE_H__
#define __FOE_H__
/*****************************************************************************/
+/** FoE error enumeration type.
+ */
typedef enum {
- FOE_BUSY = 0,
- FOE_READY = 1,
- FOE_IDLE = 2,
- FOE_WC_ERROR = 3,
- FOE_RECEIVE_ERROR = 4,
- FOE_PROT_ERROR = 5,
- FOE_NODATA_ERROR = 6,
- FOE_PACKETNO_ERROR = 7,
- FOE_OPCODE_ERROR = 8,
- FOE_TIMEOUT_ERROR = 9,
- FOE_SEND_RX_DATA_ERROR = 10,
- FOE_RX_DATA_ACK_ERROR = 11,
- FOE_ACK_ERROR = 12,
- FOE_MBOX_FETCH_ERROR = 13,
- FOE_READ_NODATA_ERROR = 14,
- FOE_MBOX_PROT_ERROR = 15,
+ FOE_BUSY = 0, /**< Busy. */
+ FOE_READY = 1, /**< Ready. */
+ FOE_IDLE = 2, /**< Idle. */
+ FOE_WC_ERROR = 3, /**< Working counter error. */
+ FOE_RECEIVE_ERROR = 4, /**< Receive error. */
+ FOE_PROT_ERROR = 5, /**< Protocol error. */
+ FOE_NODATA_ERROR = 6, /**< No data error. */
+ FOE_PACKETNO_ERROR = 7, /**< Packet number error. */
+ FOE_OPCODE_ERROR = 8, /**< OpCode error. */
+ FOE_TIMEOUT_ERROR = 9, /**< Timeout error. */
+ FOE_SEND_RX_DATA_ERROR = 10, /**< Error sending received data. */
+ FOE_RX_DATA_ACK_ERROR = 11, /**< Error acknowledging received data. */
+ FOE_ACK_ERROR = 12, /**< Acknowledge error. */
+ FOE_MBOX_FETCH_ERROR = 13, /**< Error fetching data from mailbox. */
+ FOE_READ_NODATA_ERROR = 14, /**< No data while reading. */
+ FOE_MBOX_PROT_ERROR = 15, /**< Mailbox protocol error. */
} ec_foe_error_t;
/*****************************************************************************/