mbed_uart.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef MBED_UART_H_
#define MBED_UART_H_
 
// Platform support needs to be C-compatible to work with other drivers
#ifdef __cplusplus
extern "C"
{
#endif
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
#include <stdio.h>
#include <stdbool.h>
 
/******************************************************************************/
/********************** Variables and User defined data types *****************/
/******************************************************************************/
 
/*
 * Note: The structure members are not strongly typed, as this file is included
 *       in application specific '.c' files. The mbed code structure does not
 *       allow inclusion of mbed driver files (e.g. mbed.h) into '.c' files.
 *       All the members are hence typecasted to mbed specific type during
 *       uart init and read/write operations.
 **/
 
struct mbed_uart_init_param {
    bool virtual_com_enable;    /* To enable the selection between
                                 * Virtual COM Port Or standard UART link */
    uint16_t uart_tx_pin;       /* UART Transmit Pin (only for UART comm) */
    uint16_t uart_rx_pin;       /* UART Receive Pin (only for UART comm) */
    uint16_t vendor_id;         /* USB VCOM Vendor ID (only for USB Virtual comm) */
    uint16_t product_id;        /* USB VCOM Product ID (only for USB Virtual comm) */
    char *serial_number;        /* USB VCOM serial number (only for USB Virtual comm) */
    bool is_console_stdio_port; /* Set the UART/USB port for console stdio operation */
};
 
struct mbed_uart_desc {
    void *uart_port;            /* UART port instance */
    bool virtual_com_enable;    /* To enable the selection between  Virtual COM Port
                                 * Or standard UART link */
    bool is_console_stdio_port; /* Set the UART/USB port for console stdio operation */
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
 
#ifdef __cplusplus // Closing extern c
}
#endif
 
#endif /* MBED_UART_H_ */