Nut/OS  4.10.3
API Reference
atcan.h
Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2005-2007 proconX Pty Ltd <www.proconx.com>
00003  *
00004  * Redistribution and use in source and binary forms, with or without
00005  * modification, are permitted provided that the following conditions
00006  * are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. Neither the name of the copyright holders nor the names of
00014  *    contributors may be used to endorse or promote products derived
00015  *    from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
00018  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00019  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00020  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
00021  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00022  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00023  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00024  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00025  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00026  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00027  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00028  * SUCH DAMAGE.
00029  *
00030  * For additional information see http://www.ethernut.de/
00031  *
00032  */
00033 
00045 
00046 #ifndef _ATCAN_H_
00047 #define _ATCAN_H_
00048 
00049 #include <dev/can_dev.h>
00050 #include <stdint.h>
00051 
00052 extern NUTDEVICE devAtCan;
00053 
00054 #if defined(__AVR_AT90CAN128__) /* Fails to compile on ARM and ICCAVR. */
00055 
00056 #define ATCAN_MAX_MOB   15   ///< Number of messages objects
00057 
00063 enum CAN_RESULT
00064 {
00065    CAN_SUCCESS       =  0,   
00066    CAN_TXBUF_FULL    = -1,   
00067    CAN_RXBUF_EMPTY   = -2,   
00068    CAN_ILLEGAL_MOB   = -3,   
00069    CAN_INVALID_SPEED = -4,   
00070    CAN_PASSIVE       = -5,   
00071    CAN_BUS_OFF       = -6,   
00072 };
00073  
00074 int8_t AtCanGetBusState(void);
00075 
00076 int8_t AtCanEnableMsgObj(uint8_t mob,
00077                          uint32_t id, int8_t idIsExt, int8_t idRemTag,
00078                          uint32_t mask, int8_t maskIsExt, int8_t maskRemTag);
00079 
00080 int8_t AtCanEnableRx(uint8_t noOfMsgObjs,
00081                      uint32_t id, int8_t idIsExt, int8_t idRemTag,
00082                      uint32_t mask, int8_t maskIsExt, int8_t maskRemTag);
00083 #endif
00084 
00085 #endif
00086