tamagawa_soc_uart_interface.h

Go to the documentation of this file.

/*
 * Copyright (C) 2023 Texas Instruments Incorporated
 *
 * 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.
 */
 
#ifndef TAMAGAWA_UART_DRV_H_
#define TAMAGAWA_UART_DRV_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define MAX_EEPROM_ADDRESS (127)
 
#define MAX_EEPROM_WRITE_DATA (255)
 
enum data_id
{
    DATA_ID_0,  
    DATA_ID_1,  
    DATA_ID_2,  
    DATA_ID_3,  
    DATA_ID_6,  
    DATA_ID_7,  
    DATA_ID_8,  
    DATA_ID_C,  
    DATA_ID_D,  
    DATA_ID_NUM 
};
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
struct tamagawa_tx
{
    uint8_t  adf;   
    uint8_t  edf;   
};
 
struct tamagawa_rx
{
    uint32_t abs;   
    uint32_t abm;   
    uint8_t  cf;    
    uint8_t  sf;    
    uint8_t  enid;  
    uint8_t  almc;  
    uint8_t  adf;   
    uint8_t  edf;   
    uint8_t  crc;   
};
struct tamagawa_uart_interface
{
    uint8_t  data_id;  
    struct tamagawa_tx tx;      
    struct tamagawa_rx rx;      
    uint8_t  rx_crc;   
    uint32_t uart_instance; 
    uint32_t gpio_base_address; 
    uint32_t gpio_pin_number;   
};
 
/* ========================================================================== */
/*                       Function Declarations                                */
/* ========================================================================== */
int32_t tamagawa_command_process(volatile struct tamagawa_uart_interface *tamagawa_interface, UARTLLD_Handle *gUartHandle, int32_t cmd);
int32_t tamagawa_crc_verify(volatile struct tamagawa_uart_interface *tamagawa_interface);
void tamagawa_init(volatile struct tamagawa_uart_interface *tamagawa_interface, uint32_t instance , uint32_t base_address, uint32_t pin_number, uint32_t pin_direction);
 
#ifdef __cplusplus
}
#endif
 
#endif