mcp2515.h

/*
 * Author: Jon Trulson <jtrulson@ics.com>
 * Copyright (c) 2016 Intel Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#pragma once

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <upm.h>

#include <mraa/i2c.h>
#include <mraa/spi.h>
#include <mraa/gpio.h>

#include "mcp2515_regs.h"

#ifdef __cplusplus
extern "C" {
#endif

    typedef struct _mcp2515_context {
        mraa_spi_context        spi;

        // CS pin, if we are using one
        mraa_gpio_context       gpio;

        // interrupt, if enabled
        mraa_gpio_context       intr;
    } *mcp2515_context;

    mcp2515_context mcp2515_init(int bus, int cs_pin);

    void mcp2515_close(mcp2515_context dev);

    upm_result_t mcp2515_reset(const mcp2515_context dev);

    upm_result_t mcp2515_set_opmode(const mcp2515_context dev,
                                    MCP2515_OPMODE_T opmode);

    upm_result_t mcp2515_set_speed(const mcp2515_context dev,
                                   MCP2515_SPEED_T speed);

    upm_result_t mcp2515_load_tx_buffer(const mcp2515_context dev,
                                        MCP2515_TX_BUFFER_T bufnum,
                                        int id, bool ext, bool rtr,
                                        uint8_t *payload, int len);

    upm_result_t mcp2515_transmit_buffer(const mcp2515_context dev,
                                         MCP2515_TX_BUFFER_T bufnum,
                                         bool wait);

    bool mcp2515_tx_buffer_is_free(const mcp2515_context dev,
                                   MCP2515_TX_BUFFER_T bufnum);

    MCP2515_TX_BUFFER_T mcp2515_find_free_tx_buffer(const mcp2515_context dev);

    upm_result_t mcp2515_set_tx_buffer_priority(const mcp2515_context dev,
                                                MCP2515_TX_BUFFER_T bufnum,
                                                MCP2515_TXP_T priority);

    upm_result_t mcp2515_abort_tx(const mcp2515_context dev,
                                  MCP2515_TX_BUFFER_T bufnum);

    upm_result_t mcp2515_set_rx_buffer_mode(const mcp2515_context dev,
                                            MCP2515_RX_BUFFER_T bufnum,
                                            MCP2515_RXMODE_T rxm);

    MCP2515_RXMSG_T mcp2515_rx_status_msgs(const mcp2515_context dev);

    MCP2515_MSGTYPE_T mcp2515_rx_status_msg_type(const mcp2515_context dev);

    MCP2515_FILTERMATCH_T mcp2515_rx_status_filtermatch(const mcp2515_context dev);

    upm_result_t mcp2515_get_rx_msg(const mcp2515_context dev,
                                    MCP2515_RX_BUFFER_T bufnum,
                                    MCP2515_MSG_T *msg);

    void mcp2515_print_msg(const mcp2515_context dev, MCP2515_MSG_T *msg);

    upm_result_t mcp2515_install_isr(const mcp2515_context dev, int pin,
                                     void (*isr)(void *), void *arg);

    void mcp2515_uninstall_isr(const mcp2515_context dev);

    upm_result_t mcp2515_set_intr_enables(const mcp2515_context dev,
                                          uint8_t enables);

    upm_result_t mcp2515_get_intr_flags(const mcp2515_context dev,
                                        uint8_t *flags);

    upm_result_t mcp2515_set_intr_flags(const mcp2515_context dev,
                                        uint8_t flags);

    upm_result_t mcp2515_clear_intr_flags(const mcp2515_context dev,
                                          uint8_t flags);

    upm_result_t mcp2515_get_error_flags(const mcp2515_context dev,
                                         uint8_t *flags);

    upm_result_t mcp2515_clear_error_flags(const mcp2515_context dev,
                                           uint8_t flags);

    upm_result_t mcp2515_set_filter(const mcp2515_context dev,
                                    MCP2515_RX_FILTER_T filter, bool ext,
                                    int id);

    upm_result_t mcp2515_set_mask(const mcp2515_context dev,
                                  MCP2515_RX_MASK_T mask, bool ext, int id);

    upm_result_t mcp2515_bus_read(const mcp2515_context dev, uint8_t cmd,
                                  uint8_t *args, unsigned int arglen,
                                  uint8_t *data, uint8_t len);

    upm_result_t mcp2515_bus_write(const mcp2515_context dev, uint8_t cmd,
                                   uint8_t *data, uint8_t len);

    upm_result_t mcp2515_write_reg(const mcp2515_context dev, uint8_t reg,
                                   uint8_t value);

    upm_result_t mcp2515_write_regs(const mcp2515_context dev, uint8_t reg,
                                    uint8_t *buffer, int len);

    upm_result_t mcp2515_read_reg(const mcp2515_context dev, uint8_t reg,
                                  uint8_t *value);

    upm_result_t mcp2515_bit_modify(const mcp2515_context dev, uint8_t addr,
                                    uint8_t mask, uint8_t value);

#ifdef __cplusplus
}
#endif