TCAN455X.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023, Texas Instruments Incorporated
 * 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 following disclaimer.
 *
 * *  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.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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.
 */
/*!*****************************************************************************
 *  @file       TCAN455X.h
 *
 *  @brief      TCAN455X Driver Interface
 *
 *  @anchor ti_drivers_TCAN455X_Overview
 *
 *  # Overview
 *  The TCAN455X driver performs the hardware access to the TCAN455x CAN
 *  controller with integrated transceiver via SPI.
 *
 *  ## Message RAM Size
 *  The TCAN455X device has 2KB of message RAM.
 *******************************************************************************
 */

#ifndef ti_drivers_can_tcan455x__include
#define ti_drivers_can_tcan455x__include

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

#define TCAN455X_MRAM_SIZE 2048U

typedef struct
{
    uint32_t clkFreqMHz;        
    uint32_t spiBitRate;        
    void *taskStack;            
    uint16_t taskStackSize;     
    uint8_t taskPri;            
    uint_least8_t spiIndex;     
    uint_least8_t spiCSPin;     
    uint_least8_t interruptPin; 
} TCAN455X_Config;

/* Externs from ti_drivers_config.c */
extern const TCAN455X_Config TCAN455X_config;

uint32_t TCAN455X_getStatus(void);

void TCAN455X_clearStatus(void);

void TCAN455X_setMode(uint32_t mode);

uint32_t TCAN455X_getMode(void);

void TCAN455X_disableSleepWakeErrorTimeout(void);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_can_tcan455x__include */