blob: d18fd099e92899c893e5b4dd0ffa6a6c1aeac535 [file] [log] [blame]
/* ----------------------------------------------------------------------------
* ATMEL Microcontroller Software Support
* ----------------------------------------------------------------------------
* Copyright (c) 2011, Atmel Corporation
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the disclaimer below.
*
* Atmel's name may not be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
* DISCLAIMED. IN NO EVENT SHALL ATMEL 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.
* ----------------------------------------------------------------------------
*/
/**
* \file
*
* Definitions and function prototype for CAN.
*/
#ifndef _CAN_
#define _CAN_
/*----------------------------------------------------------------------------
* Definitions
*----------------------------------------------------------------------------*/
/* CAN API return status */
#define CAN_STATUS_SUCCESS 0
#define CAN_STATUS_LOCKED 1
#define CAN_STATUS_ABORTED 2
#define CAN_STATUS_RESET 3
/*----------------------------------------------------------------------------
* Types
*----------------------------------------------------------------------------*/
typedef struct _SCanTransfer
{
volatile uint8_t state ;
volatile uint8_t mailbox_number ;
volatile uint8_t sync_can ;
volatile uint32_t mode_reg ; /* CAN_MMR */
volatile uint32_t acceptance_mask_reg ; /* CAN_MAM */
volatile uint32_t identifier ; /* CAN_MID */
volatile uint32_t data_low_reg ; /* CAN_MDL */
volatile uint32_t data_high_reg ; /* CAN_MDH */
volatile uint32_t control_reg ; /* CAN_MCR */
volatile uint32_t mailbox_in_use ;
volatile int size ;
} SCanTransfer ;
/*----------------------------------------------------------------------------
* Exported functions
*----------------------------------------------------------------------------*/
extern uint32_t CAN_Init( Can* pCan, uint32_t dwMCK, uint32_t dwBaudrate, SCanTransfer *pTransfer) ;
extern void CAN_Disable( Can* pCan ) ;
extern void CAN_ResetAllMailbox( Can* pCan, SCanTransfer* pTransfer) ;
extern void CAN_TransferReset( Can* pCan, SCanTransfer* pTransfer ) ;
extern void CAN_InitMailboxRegisters( Can* pCan, SCanTransfer* pTransfer ) ;
extern uint32_t CAN_Write( Can* pCan, SCanTransfer* pTransfer ) ;
extern uint32_t CAN_Read( Can* pCan, SCanTransfer* pTransfer ) ;
extern uint32_t CAN_IsInIdle( Can* pCan, SCanTransfer* pTransfer ) ;
extern void CAN_Handler( Can* pCan, SCanTransfer* pTransfer ) ;
#endif /* _CAN_ */