50 lines
2 KiB
C
50 lines
2 KiB
C
// This file is part of the CircuitPython project: https://circuitpython.org
|
|
//
|
|
// SPDX-FileCopyrightText: Copyright (c) 2016 Scott Shawcroft for Adafruit Industries
|
|
//
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
#pragma once
|
|
|
|
#include "common-hal/microcontroller/Pin.h"
|
|
#include "common-hal/busio/UART.h"
|
|
#include "py/ringbuf.h"
|
|
|
|
extern const mp_obj_type_t busio_uart_type;
|
|
|
|
typedef enum {
|
|
BUSIO_UART_PARITY_NONE,
|
|
BUSIO_UART_PARITY_EVEN,
|
|
BUSIO_UART_PARITY_ODD
|
|
} busio_uart_parity_t;
|
|
|
|
// Construct an underlying UART object.
|
|
extern void common_hal_busio_uart_construct(busio_uart_obj_t *self,
|
|
const mcu_pin_obj_t *tx, const mcu_pin_obj_t *rx,
|
|
const mcu_pin_obj_t *rts, const mcu_pin_obj_t *cts,
|
|
const mcu_pin_obj_t *rs485_dir, bool rs485_invert,
|
|
uint32_t baudrate, uint8_t bits, busio_uart_parity_t parity, uint8_t stop,
|
|
mp_float_t timeout, uint16_t receiver_buffer_size, byte *receiver_buffer,
|
|
bool sigint_enabled);
|
|
|
|
extern void common_hal_busio_uart_deinit(busio_uart_obj_t *self);
|
|
extern bool common_hal_busio_uart_deinited(busio_uart_obj_t *self);
|
|
|
|
// Read characters. len is in characters NOT bytes!
|
|
extern size_t common_hal_busio_uart_read(busio_uart_obj_t *self,
|
|
uint8_t *data, size_t len, int *errcode);
|
|
|
|
// Write characters. len is in characters NOT bytes!
|
|
extern size_t common_hal_busio_uart_write(busio_uart_obj_t *self,
|
|
const uint8_t *data, size_t len, int *errcode);
|
|
|
|
extern uint32_t common_hal_busio_uart_get_baudrate(busio_uart_obj_t *self);
|
|
extern void common_hal_busio_uart_set_baudrate(busio_uart_obj_t *self, uint32_t baudrate);
|
|
extern mp_float_t common_hal_busio_uart_get_timeout(busio_uart_obj_t *self);
|
|
extern void common_hal_busio_uart_set_timeout(busio_uart_obj_t *self, mp_float_t timeout);
|
|
|
|
extern uint32_t common_hal_busio_uart_rx_characters_available(busio_uart_obj_t *self);
|
|
extern void common_hal_busio_uart_clear_rx_buffer(busio_uart_obj_t *self);
|
|
extern bool common_hal_busio_uart_ready_to_tx(busio_uart_obj_t *self);
|
|
|
|
extern void common_hal_busio_uart_never_reset(busio_uart_obj_t *self);
|