]> rtime.felk.cvut.cz Git - CanFestival-3.git/blob - include/can.h
Re-write doxygen tags in headers files to generate User API documentation
[CanFestival-3.git] / include / can.h
1 /*
2 This file is part of CanFestival, a library implementing CanOpen Stack. 
3
4 Copyright (C): Edouard TISSERANT and Francis DUPIN
5
6 See COPYING file for copyrights details.
7
8 This library is free software; you can redistribute it and/or
9 modify it under the terms of the GNU Lesser General Public
10 License as published by the Free Software Foundation; either
11 version 2.1 of the License, or (at your option) any later version.
12
13 This library is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 Lesser General Public License for more details.
17
18 You should have received a copy of the GNU Lesser General Public
19 License along with this library; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21 */
22
23 /** 
24  * @defgroup can CAN Management 
25  * @ingroup userapi
26  */
27
28 #ifndef __can_h__
29 #define __can_h__
30
31 #include "applicfg.h"
32 /** Used for the Can message structure */
33 /*
34 union SHORT_CAN {
35   struct { UNS8 b0,b1; } b;
36   UNS32 w;
37 };
38 */
39 /*
40 typedef struct {
41   UNS32 w;
42 } SHORT_CAN;
43 */
44
45 /** 
46  * @brief The CAN message structure 
47  * @ingroup can
48  * @{
49  */
50 typedef struct {
51   UNS16 cob_id; /* l'ID du mesg */
52   UNS8 rtr;                     /**< remote transmission request. 0 if not rtr, 
53                    1 for a rtr message */
54   UNS8 len;                     /**< message length (0 to 8) */
55   UNS8 data[8]; /**< data */
56 } Message;
57 /** @} */
58
59 #define Message_Initializer {0,0,0,{0,0,0,0,0,0,0,0}}
60
61 typedef UNS8 (*canSend_t)(Message *);
62
63 #endif /* __can_h__ */