2010-08-10 03:11:02 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
< html > < head > < meta http-equiv = "Content-Type" content = "text/html;charset=UTF-8" >
< title > ChibiOS/RT: can.h File Reference< / title >
< link href = "custom.css" rel = "stylesheet" type = "text/css" >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" >
< / head > < body >
< table style = "text-align: center; width: 100%;" border = "0"
cellpadding="2" cellspacing="2">
< tbody >
< tr >
< td style = "width: 80px;" > < img alt = "ChibiOS/RT Logo" src = "logo_small.png" > < / td >
< td > < big > < big > ChibiOS/RT< / big > < / big > < br > < br > Architecture - Reference Manual - Guides< / td >
< td style = "width: 80px;" > < / td >
< / tr >
< / tbody >
< / table >
< hr size = "1" >
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
2010-08-10 03:11:02 +00:00
< div class = "navigation" id = "top" >
< div class = "tabs" >
2010-11-22 05:53:37 +00:00
< ul class = "tablist" >
2010-08-10 03:11:02 +00:00
< li > < a href = "main.html" > < span > Main Page< / span > < / a > < / li >
< li > < a href = "modules.html" > < span > Modules< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Data Structures< / span > < / a > < / li >
< li class = "current" > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< / ul >
< / div >
2010-11-22 05:53:37 +00:00
< div class = "tabs2" >
< ul class = "tablist" >
2010-08-10 03:11:02 +00:00
< li > < a href = "files.html" > < span > File List< / span > < / a > < / li >
< li > < a href = "globals.html" > < span > Globals< / span > < / a > < / li >
< / ul >
< / div >
< / div >
2010-11-22 05:53:37 +00:00
< div class = "header" >
< div class = "summary" >
< a href = "#define-members" > Defines< / a > |
< a href = "#enum-members" > Enumerations< / a > |
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" >
< h1 > can.h File Reference< / h1 > < / div >
< / div >
2010-08-10 03:11:02 +00:00
< div class = "contents" >
2010-11-22 05:53:37 +00:00
2010-08-10 03:11:02 +00:00
< p > CAN Driver macros and structures.
< a href = "#_details" > More...< / a > < / p >
< code > #include " < a class = "el" href = "platforms_2_s_t_m32_2can__lld_8h_source.html" > can_lld.h< / a > " < / code > < br / >
< p > < a href = "can_8h_source.html" > Go to the source code of this file.< / a > < / p >
2010-11-22 05:53:37 +00:00
< table class = "memberdecls" >
< tr > < td colspan = "2" > < h2 > < a name = "define-members" > < / a >
Defines< / h2 > < / td > < / tr >
2010-08-10 03:11:02 +00:00
< tr > < td class = "memItemLeft" align = "right" valign = "top" > #define < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#ga9e84b4cbbb9eb88519aa922ae9c33f09" > CAN_LIMIT_WARNING< / a > 1< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Errors rate warning. < a href = "group___c_a_n.html#ga9e84b4cbbb9eb88519aa922ae9c33f09" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > #define < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#ga50706597b6872fbf90222fede47d1f54" > CAN_LIMIT_ERROR< / a > 2< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Errors rate error. < a href = "group___c_a_n.html#ga50706597b6872fbf90222fede47d1f54" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > #define < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#gaaa317e7894d81461722dfeb4aa2c14dd" > CAN_BUS_OFF_ERROR< / a > 4< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Bus off condition reached. < a href = "group___c_a_n.html#gaaa317e7894d81461722dfeb4aa2c14dd" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > #define < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#ga76f084f2cf0c2088ed0d8948e6075709" > CAN_FRAMING_ERROR< / a > 8< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Framing error of some kind on the CAN bus. < a href = "group___c_a_n.html#ga76f084f2cf0c2088ed0d8948e6075709" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > #define < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#ga8da95bff65bea0790d564841895c42d0" > CAN_OVERFLOW_ERROR< / a > 16< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Overflow in receive queue. < a href = "group___c_a_n.html#ga8da95bff65bea0790d564841895c42d0" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > #define < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#ga5294d9d12e4186c781df3b2f1d8bd80b" > CAN_USE_SLEEP_MODE< / a > TRUE< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Sleep mode related APIs inclusion switch. < a href = "group___c_a_n.html#ga5294d9d12e4186c781df3b2f1d8bd80b" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > #define < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#ga41491eed34c87bf9b8f225a007266e58" > canAddFlagsI< / a > (canp, mask) ((canp)-> cd_status |= (mask))< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Adds some flags to the CAN status mask. < a href = "group___c_a_n.html#ga41491eed34c87bf9b8f225a007266e58" > < / a > < br / > < / td > < / tr >
2010-11-22 05:53:37 +00:00
< tr > < td colspan = "2" > < h2 > < a name = "enum-members" > < / a >
Enumerations< / h2 > < / td > < / tr >
2010-08-10 03:11:02 +00:00
< tr > < td class = "memItemLeft" align = "right" valign = "top" > enum < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#gaca62464ffdcedae03d49adf3f6ce870e" > canstate_t< / a > { < br / >
< a class = "el" href = "group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea91fe9adee6b7f27be97e8b59439774cc" > CAN_UNINIT< / a > = 0,
< a class = "el" href = "group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea6ed84a3a97073b3e04918a90d90dd11e" > CAN_STOP< / a > = 1,
< a class = "el" href = "group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf10eb7d86ea8728c90d931f34a432394" > CAN_STARTING< / a > = 2,
< a class = "el" href = "group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870eaf6cc9dbdefe635c9db9dca135cc94610" > CAN_READY< / a > = 3,
< br / >
< a class = "el" href = "group___c_a_n.html#ggaca62464ffdcedae03d49adf3f6ce870ea7b6ee207a3d1bfec35374f0d3964e6aa" > CAN_SLEEP< / a > = 4
< br / >
}< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > < p > Driver state machine possible states. < / p >
< a href = "group___c_a_n.html#gaca62464ffdcedae03d49adf3f6ce870e" > More...< / a > < br / > < / td > < / tr >
2010-11-22 05:53:37 +00:00
< tr > < td colspan = "2" > < h2 > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
2010-08-10 03:11:02 +00:00
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#ga2d3efc34f7704ab23c293aac2be47764" > canInit< / a > (void)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > CAN Driver initialization. < a href = "group___c_a_n.html#ga2d3efc34f7704ab23c293aac2be47764" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#gadf8c892ca4bd2544d03be8a690885aef" > canObjectInit< / a > (< a class = "el" href = "struct_c_a_n_driver.html" > CANDriver< / a > *canp)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Initializes the standard part of a < code > < a class = "el" href = "struct_c_a_n_driver.html" title = "Structure representing an CAN driver." > CANDriver< / a > < / code > structure. < a href = "group___c_a_n.html#gadf8c892ca4bd2544d03be8a690885aef" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#ga05d2448864b2cae4674ed7e6f3c576b8" > canStart< / a > (< a class = "el" href = "struct_c_a_n_driver.html" > CANDriver< / a > *canp, const < a class = "el" href = "struct_c_a_n_config.html" > CANConfig< / a > *config)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Configures and activates the CAN peripheral. < a href = "group___c_a_n.html#ga05d2448864b2cae4674ed7e6f3c576b8" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#ga4e89a7d246119e077d27431a02586133" > canStop< / a > (< a class = "el" href = "struct_c_a_n_driver.html" > CANDriver< / a > *canp)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Deactivates the CAN peripheral. < a href = "group___c_a_n.html#ga4e89a7d246119e077d27431a02586133" > < / a > < br / > < / td > < / tr >
2010-11-22 05:53:37 +00:00
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" > msg_t< / a > < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#gad9c686d19b4319ef586af3631b779c6c" > canTransmit< / a > (< a class = "el" href = "struct_c_a_n_driver.html" > CANDriver< / a > *canp, const < a class = "el" href = "struct_c_a_n_tx_frame.html" > CANTxFrame< / a > *ctfp, < a class = "el" href = "group__types.html#gae3e32a98d431a02106616da3071832dd" > systime_t< / a > timeout)< / td > < / tr >
2010-08-10 03:11:02 +00:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Can frame transmission. < a href = "group___c_a_n.html#gad9c686d19b4319ef586af3631b779c6c" > < / a > < br / > < / td > < / tr >
2010-11-22 05:53:37 +00:00
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" > msg_t< / a > < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#ga557d845167f6ab4f224b036860411db5" > canReceive< / a > (< a class = "el" href = "struct_c_a_n_driver.html" > CANDriver< / a > *canp, < a class = "el" href = "struct_c_a_n_rx_frame.html" > CANRxFrame< / a > *crfp, < a class = "el" href = "group__types.html#gae3e32a98d431a02106616da3071832dd" > systime_t< / a > timeout)< / td > < / tr >
2010-08-10 03:11:02 +00:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Can frame receive. < a href = "group___c_a_n.html#ga557d845167f6ab4f224b036860411db5" > < / a > < br / > < / td > < / tr >
2010-11-22 05:53:37 +00:00
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "group___c_a_n___l_l_d.html#ga4a6894bc11434dfa96263dcd72735330" > canstatus_t< / a > < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group___c_a_n.html#ga377a78b04ad6733e24b31615b76cdada" > canGetAndClearFlags< / a > (< a class = "el" href = "struct_c_a_n_driver.html" > CANDriver< / a > *canp)< / td > < / tr >
2010-08-10 03:11:02 +00:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Returns the current status mask and clears it. < a href = "group___c_a_n.html#ga377a78b04ad6733e24b31615b76cdada" > < / a > < br / > < / td > < / tr >
< / table >
< hr / > < a name = "_details" > < / a > < h2 > Detailed Description< / h2 >
< p > CAN Driver macros and structures. < / p >
< p > Definition in file < a class = "el" href = "can_8h_source.html" > can.h< / a > .< / p >
< / div >
< hr size = "1" > < address style = "text-align: right;" > < small >
2010-11-30 04:54:43 +00:00
Generated on Sun Nov 28 2010 14:09:49 for ChibiOS/RT by < a href = "http://www.doxygen.org/index.html" > < img src = "doxygen.png" alt = "doxygen" align = "middle" border = "0" > < / a > 1.7.1< / small > < / address >
2010-08-10 03:11:02 +00:00
< / body >
< / html >
