70 lines
2.0 KiB
C
70 lines
2.0 KiB
C
|
/**
|
||
|
|
* @section License
|
||
|
|
*
|
||
|
|
* The MIT License (MIT)
|
||
|
|
*
|
||
|
|
* Copyright (c) 2017, Thomas Barth, barth-dev.de
|
||
|
|
*
|
||
|
|
* Permission is hereby granted, free of charge, to any person
|
||
|
|
* obtaining a copy of this software and associated documentation
|
||
|
|
* files (the "Software"), to deal in the Software without
|
||
|
|
* restriction, including without limitation the rights to use, copy,
|
||
|
|
* modify, merge, publish, distribute, sublicense, and/or sell copies
|
||
|
|
* of the Software, and to permit persons to whom the Software is
|
||
|
|
* furnished to do so, subject to the following conditions:
|
||
|
|
*
|
||
|
|
* The above copyright notice and this permission notice shall be
|
||
|
|
* included in all copies or substantial portions of the Software.
|
||
|
|
*
|
||
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
||
|
|
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
||
|
|
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||
|
|
* SOFTWARE.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef __DRIVERS_CAN_H__
|
||
|
|
#define __DRIVERS_CAN_H__
|
||
|
|
|
||
|
|
#include <stdint.h>
|
||
|
|
#include "CAN_config.h"
|
||
|
|
|
||
|
|
/** \brief CAN Frame structure */
|
||
|
|
typedef struct {
|
||
|
|
uint8_t Extended;
|
||
|
|
uint32_t MsgID; /**< \brief Message ID */
|
||
|
|
uint32_t DLC; /**< \brief Length */
|
||
|
|
union {
|
||
|
|
uint8_t u8[8]; /**< \brief Payload byte access*/
|
||
|
|
uint32_t u32[2]; /**< \brief Payload u32 access*/
|
||
|
|
} data;
|
||
|
|
}CAN_frame_t;
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Initialize the CAN Module
|
||
|
|
*
|
||
|
|
* \return 0 CAN Module had been initialized
|
||
|
|
*/
|
||
|
|
int CAN_init(void);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Send a can frame
|
||
|
|
*
|
||
|
|
* \param p_frame Pointer to the frame to be send, see #CAN_frame_t
|
||
|
|
* \return 0 Frame has been written to the module
|
||
|
|
*/
|
||
|
|
int CAN_write_frame(const CAN_frame_t* p_frame);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* \brief Stops the CAN Module
|
||
|
|
*
|
||
|
|
* \return 0 CAN Module was stopped
|
||
|
|
*/
|
||
|
|
int CAN_stop(void);
|
||
|
|
|
||
|
|
#endif
|