/**
 * @file
 * @brief CAN frame headers.
 */
#ifndef STA_CORE_CAN_HEADERS_HPP
#define STA_CORE_CAN_HEADERS_HPP

#include <sta/can/id.hpp>

#include <cstdint>


namespace sta
{
	/**
	 * @defgroup canHeader Frame headers
	 * @ingroup canAPI
	 * @brief CAN header types for transmitted / received frames.
	 */


	/**
	 * @brief CAN TX frame header.
	 *
	 * @ingroup canHeader
	 */
	struct CanTxHeader
	{
		CanFrameId id;              /**< Frame ID */
		uint8_t    payloadLength;   /**< Size of data to send */
	};

	/**
	 * @brief CAN RX frame header.
	 *
	 * @ingroup canHeader
	 */
	struct CanRxHeader
	{
		CanFrameId  id;             /**< Frame ID */
		uint8_t     payloadLength;  /**< Size of received data */
		uint32_t    timestamp;      /**< RX timestamp */
		uint8_t     filter;         /**< RX filter match */
	};
} // namespace sta


#endif // STA_CORE_CAN_HEADERS_HPP