mcp2515_private.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
/*
 * Copyright (c) 2007 Fabian Greif, Roboterclub Aachen e.V.
 *  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $Id: mcp2515_private.h 6910 2008-11-30 21:13:14Z fabian $
 */
// ----------------------------------------------------------------------------

#ifndef MCP2515_PRIVATE_H
#define MCP2515_PRIVATE_H

// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------

#include <avr/io.h>
#include <avr/pgmspace.h>
#include <inttypes.h>
#include <stdbool.h>

#include "can.h"
#include "utils.h"

#include "can_private.h"
#include "spi.h"

// ----------------------------------------------------------------------------

#if (BUILD_FOR_MCP2515 == 1)
        #if defined(__AVR_ATmega16__) || defined(__AVR_ATmega32__) || defined(__AVR_ATmega644__)
                #define P_MOSI  B,5
                #define P_MISO  B,6
                #define P_SCK   B,7
                #define SUPPORT_FOR_MCP2515__
        #elif defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__)
                #define P_MOSI  B,2
                #define P_MISO  B,3
                #define P_SCK   B,1
                #define SUPPORT_FOR_MCP2515__
        #elif defined(__AVR_ATmega8__)  || defined(__AVR_ATmega48__) || \
                  defined(__AVR_ATmega88__) || defined(__AVR_ATmega168__) || defined(__AVR_ATmega328P__)
                #define P_MOSI  B,3
                #define P_MISO  B,4
                #define P_SCK   B,5
                #define SUPPORT_FOR_MCP2515__
        #elif defined(__AVR_ATmega128__)
                #define P_MOSI  B,2
                #define P_MISO  B,3
                #define P_SCK   B,1
                #define SUPPORT_FOR_MCP2515__
        #elif defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__)
                #define P_MOSI  B,0
                #define P_MISO  B,1
                #define P_SCK   B,2
                
                #define USE_SOFTWARE_SPI                1
                #define SUPPORT_FOR_MCP2515__
        #else
                #error  choosen AVR-type is not supported yet!
        #endif
#endif


#ifdef  SUPPORT_FOR_MCP2515__

// ----------------------------------------------------------------------------
// load some default values

#ifndef MCP2515_CLKOUT_PRESCALER
        #define MCP2515_CLKOUT_PRESCALER        0
#endif
#ifndef MCP2515_INTERRUPTS
        #define MCP2515_INTERRUPTS                      (1<<RX1IE)|(1<<RX0IE)
#endif

// ----------------------------------------------------------------------------
// TODO: this file is imcompatible with the at90can
#include "mcp2515_defs.h"

#ifndef MCP2515_CS
        #error  MCP2515_CS ist nicht definiert!
#endif

#if defined(MCP2515_RX0BF) && !defined(MCP2515_RX1BF)
        #warning        only MCP2515_RX0BF but not MCP2515_RX1BF defined!
#elif !defined(MCP2515_RX0BF) && defined(MCP2515_RX1BF)
        #warning        only MCP2515_RX1BF but not MCP2515_RX0BF defined!
#elif defined(MCP2515_RX0BF) && defined(MCP2515_RX1BF)
        #define RXnBF_FUNKTION
#endif

// -------------------------------------------------------------------------
extern void mcp2515_write_register( uint8_t adress, uint8_t data );

// -------------------------------------------------------------------------
extern uint8_t mcp2515_read_register(uint8_t adress);

extern uint8_t mcp2515_read_status(uint8_t type);

// -------------------------------------------------------------------------
extern void mcp2515_bit_modify(uint8_t adress, uint8_t mask, uint8_t data);

// -------------------------------------------------------------------------
extern __attribute__ ((gnu_inline)) inline void mcp2515_change_operation_mode(uint8_t mode)
{
        mcp2515_bit_modify(CANCTRL, 0xe0, mode);
        while ((mcp2515_read_register(CANSTAT) & 0xe0) != (mode & 0xe0))
                ;
}

// -------------------------------------------------------------------------
#if     SUPPORT_EXTENDED_CANID

extern void mcp2515_write_id( const uint32_t *id, uint8_t extended );

extern uint8_t mcp2515_read_id( uint32_t *id );

#else

extern void mcp2515_write_id( const uint16_t *id );

extern uint8_t mcp2515_read_id( uint16_t *id );

#endif  // USE_EXTENDED_CANID

#endif  // SUPPORT_FOR_MCP2515__

#endif  // MCP2515_PRIVATE_H