include/can.h
author greg
Thu, 16 Jul 2009 10:06:57 +0200
changeset 561 f9be4262c68d
parent 528 0a30e161d63c
child 691 17d9c0736935
permissions -rwxr-xr-x
Add doxygen comments in headers file
modify Doxyfile
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     1
/*
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     2
This file is part of CanFestival, a library implementing CanOpen Stack. 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     3
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     4
Copyright (C): Edouard TISSERANT and Francis DUPIN
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     5
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     6
See COPYING file for copyrights details.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     7
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     8
This library is free software; you can redistribute it and/or
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     9
modify it under the terms of the GNU Lesser General Public
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    10
License as published by the Free Software Foundation; either
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    11
version 2.1 of the License, or (at your option) any later version.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    12
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    13
This library is distributed in the hope that it will be useful,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    14
but WITHOUT ANY WARRANTY; without even the implied warranty of
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    15
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    16
Lesser General Public License for more details.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    17
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    18
You should have received a copy of the GNU Lesser General Public
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    19
License along with this library; if not, write to the Free Software
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    20
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    21
*/
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    22
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    23
#ifndef __can_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    24
#define __can_h__
145
e747d2e26af0 Win32 Native support and dynamicaly loaded CAN drivers for Linux, Cygwin and Win32.
etisserant
parents: 71
diff changeset
    25
e747d2e26af0 Win32 Native support and dynamicaly loaded CAN drivers for Linux, Cygwin and Win32.
etisserant
parents: 71
diff changeset
    26
#include "applicfg.h"
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 528
diff changeset
    27
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    28
/*
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    29
union SHORT_CAN {
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    30
  struct { UNS8 b0,b1; } b;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    31
  UNS32 w;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    32
};
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    33
*/
365
9b76e0881beb Changed cob_id from struct{UNS32} to UNS16
etisserant
parents: 235
diff changeset
    34
/*
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    35
typedef struct {
365
9b76e0881beb Changed cob_id from struct{UNS32} to UNS16
etisserant
parents: 235
diff changeset
    36
  UNS32 w;
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    37
} SHORT_CAN;
365
9b76e0881beb Changed cob_id from struct{UNS32} to UNS16
etisserant
parents: 235
diff changeset
    38
*/
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    39
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 365
diff changeset
    40
/** 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 365
diff changeset
    41
 * @brief The CAN message structure 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 365
diff changeset
    42
 * @ingroup can
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 365
diff changeset
    43
 */
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    44
typedef struct {
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 528
diff changeset
    45
  UNS16 cob_id;	/**< message's ID */
f9be4262c68d Add doxygen comments in headers file
greg
parents: 528
diff changeset
    46
  UNS8 rtr;		/**< remote transmission request. (0 if not rtr message, 1 if rtr message) */
f9be4262c68d Add doxygen comments in headers file
greg
parents: 528
diff changeset
    47
  UNS8 len;		/**< message's length (0 to 8) */
f9be4262c68d Add doxygen comments in headers file
greg
parents: 528
diff changeset
    48
  UNS8 data[8]; /**< message's datas */
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    49
} Message;
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    50
235
f812bf6b7237 Preliminary implementation of Event Timer and Inhibit Timer driven TPDO
etisserant
parents: 145
diff changeset
    51
#define Message_Initializer {0,0,0,{0,0,0,0,0,0,0,0}}
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    52
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    53
typedef UNS8 (*canSend_t)(Message *);
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    54
71
95cd3376cc9f compilator compatitibility
frdupin
parents: 0
diff changeset
    55
#endif /* __can_h__ */