mcp2515.h

Go to the documentation of this file.

/*
 * Copyright (C) 2016 OTA keys S.A.
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef MCP2515_H
#define MCP2515_H
 
#include "mcp2515_defines.h"
#include "candev_mcp2515.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum mcp2515_mode {
    MODE_NORMAL         = MCP2515_CANSTAT_OPMOD_NORMAL,
    MODE_SLEEP          = MCP2515_CANSTAT_OPMOD_SLEEP,
    MODE_LOOPBACK       = MCP2515_CANSTAT_OPMOD_LOOPBACK,
    MODE_LISTEN_ONLY    = MCP2515_CANSTAT_OPMOD_LISTEN_ONLY,
    MODE_CONFIG         = MCP2515_CANSTAT_OPMOD_CONFIGURATION,
    MODE_UNKNOWN        = -1
};
 
enum mcp2515_interrupt {
    INT_RX0             = MCP2515_CANINTF_RX0IF,
    INT_RX1             = MCP2515_CANINTF_RX1IF,
    INT_TX0             = MCP2515_CANINTF_TX0IF,
    INT_TX1             = MCP2515_CANINTF_TX1IF,
    INT_TX2             = MCP2515_CANINTF_TX2IF,
    INT_ERROR           = MCP2515_CANINTF_ERRIF,
    INT_WAKEUP          = MCP2515_CANINTF_WAKIF,
    INT_MESSAGE_ERROR   = MCP2515_CANINTF_MERRF,
};
 
enum mcp2515_error {
    ERR_WARNING         = MCP2515_EFLG_EWARN,
    ERR_RX_WARNING      = MCP2515_EFLG_RXWAR,
    ERR_TX_WARNING      = MCP2515_EFLG_TXWAR,
    ERR_RX_PASSIVE      = MCP2515_EFLG_RXEP,
    ERR_TX_PASSIVE      = MCP2515_EFLG_TXEP,
    ERR_TX_BUS_OFF      = MCP2515_EFLG_TXBO,
    ERR_RX_0_OVERFLOW   = MCP2515_EFLG_RX0OVR,
    ERR_RX_1_OVERFLOW   = MCP2515_EFLG_RX1OVR,
};
 
#define MCP2515_WKUP_SRC_INTERNAL 1
 
int mcp2515_init(candev_mcp2515_t *dev, void (*irq_cb)(void *));
 
void mcp2515_reset(candev_mcp2515_t *dev);
 
int mcp2515_init_irqs(candev_mcp2515_t *dev);
 
int mcp2515_send(candev_mcp2515_t *dev, const struct can_frame *frame,
                 int mailbox);
 
int mcp2515_receive(candev_mcp2515_t *dev, struct can_frame *frame,
                    int mailbox);
 
int mcp2515_abort(candev_mcp2515_t *dev, int mailbox);
 
enum mcp2515_mode mcp2515_get_mode(candev_mcp2515_t *dev);
 
enum mcp2515_mode mcp2515_set_mode(candev_mcp2515_t *dev,
                                   enum mcp2515_mode mode);
 
void mcp2515_wake_up(candev_mcp2515_t *dev);
 
enum mcp2515_interrupt mcp2515_get_irq(candev_mcp2515_t *dev);
 
int mcp2515_clear_irq(candev_mcp2515_t *dev, enum mcp2515_interrupt irq);
 
int mcp2515_tx_err_occurred(candev_mcp2515_t *dev, int mailbox);
 
int mcp2515_configure_bittiming(candev_mcp2515_t *dev);
 
uint8_t mcp2515_get_errors(candev_mcp2515_t *dev);
 
int mcp2515_set_filter(candev_mcp2515_t *dev, int filter_id, uint32_t filter);
 
int mcp2515_set_mask(candev_mcp2515_t *dev, int mailbox, uint32_t mask);
 
#ifdef __cplusplus
}
#endif
 
#endif /* MCP2515_H */