hart_uart.h

 
/******************************************************************************
 *
 * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
 * Analog Devices, Inc.),
 * Copyright (C) 2023-2024 Analog Devices, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/
 
#ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_HART_UART_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_HART_UART_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
/***** Includes *******/
#include "stdint.h"
#include "afe.h"
#include "afe_adc_zero_regs.h"
#include "afe_adc_one_regs.h"
#include "afe_dac_regs.h"
#include "afe_hart_regs.h"
#include "mxc_sys.h"
#include "mxc_assert.h"
 
/***** Definitions *****/
#define NORMAL_HART_TRANSCEIVE_MODE 0
#define HART_TEST_MODE_TX_1200 1
#define HART_TEST_MODE_TX_2200 2
#define HART_TEST_MODE_EXTERNAL 3
 
#define TPDLL_COMM_ERROR_INDICATOR 0x80
#define TPDLL_VERTICAL_PARITY_ERROR 0x40
#define TPDLL_OVERRUN_ERROR 0x20
#define TPDLL_FRAMING_ERROR 0x10
#define TPDLL_BUFFER_OVERFLOW_ERROR 0x02
 
#define HART_STATE_IDLE 0
#define HART_STATE_TRANSMIT 1
#define HART_STATE_RECEIVE_ACTIVE 2
 
// Note: no flag in UARTn_INT_FL register map for buffer overflow since
//      since its a SW error
#define UART_FLAG_BUFFER_OVERFLOW_ERROR 0x80
 
typedef void (*reset_confirm_callback_t)(void);
 
typedef void (*enable_confirm_callback_t)(uint32_t);
 
typedef void (*enable_indicate_callback_t)(uint32_t);
 
typedef void (*data_confirm_callback_t)(uint8_t);
 
typedef void (*data_indicate_callback_t)(uint8_t);
 
typedef void (*error_indicate_callback_t)(uint8_t, uint8_t);
 
typedef struct {
    reset_confirm_callback_t reset_confirm_cb; 
    enable_confirm_callback_t enable_confirm_cb; 
    enable_indicate_callback_t enable_indicate_cb; 
    data_confirm_callback_t data_confirm_cb; 
    data_indicate_callback_t data_indicate_cb; 
    error_indicate_callback_t
        error_indicate_cb; 
} hart_uart_callbacks_t;
 
/***** Function Prototypes *****/
int hart_uart_setup(uint32_t test_mode);
 
void hart_uart_setup_saps(hart_uart_callbacks_t callbacks);
 
int hart_uart_enable(void);
 
int hart_uart_disable(void);
 
void hart_uart_test_transmit_1200(void);
 
void hart_uart_test_transmit_2200(void);
 
int hart_uart_send(uint8_t *data, uint32_t length);
 
int hart_uart_check_transmit_complete(void);
 
int hart_uart_get_received_packet(uint8_t *buffer, uint32_t *packet_length, uint32_t *comm_errors);
 
void hart_uart_handler(void);
 
void hart_rts_receive_mode(void);
 
void hart_rts_transmit_mode(void);
 
int hart_clock_enable(void);
 
void hart_clock_disable(void);
 
void hart_sap_reset_request(void);
 
int hart_sap_data_request(uint8_t data);
 
void hart_sap_enable_request(uint32_t state);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_HART_UART_H_