uart.h File Reference

Generic UART. More...

#include <stdint.h>
#include <ipxe/refcnt.h>
#include <ipxe/list.h>

Go to the source code of this file.

Data Structures
struct	uart
	A generic UART. More...
struct	uart_operations
	UART operations. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
static	__attribute__ ((always_inline)) void uart_transmit(struct uart *uart
	Transmit byte.
struct uart *	alloc_uart (size_t priv_len)
	Allocate UART.
int	uart_register (struct uart *uart)
	Register UART.
int	uart_register_fixed (void)
	Register fixed UARTs (when not provided by platform)
void	uart_unregister (struct uart *uart)
	Unregister UART.
struct uart *	uart_find (const char *name)
	Find named UART.

Variables
static uint8_t	byte
struct list_head	uarts
struct uart_operations	null_uart_operations
	Null UART operations.

Detailed Description

Generic UART.

Definition in file uart.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

__attribute__()

__attribute__ ( (always_inline) )

inlinestatic

Transmit byte.

Nullify UART.

Drop reference to UART.

Get reference to UART.

Flush transmitted data.

Initialise UART.

Receive byte.

Check if data is ready.

Parameters

uart	UART
byte	Byte to transmit

Return values

rc	Return status code

Parameters

uart

UART

Return values

ready

Data is ready

Parameters

uart

UART

Return values

byte	Received byte

Parameters

uart

UART

Return values

rc	Return status code

Parameters

uart	UART
uart	UART

Return values

uart

UART

Definition at line 92 of file uart.h.

                                      {
 
        return uart->op->data_ready ( uart );
}

References uart_operations::data_ready, and uart::op.

alloc_uart()

struct uart * alloc_uart ( size_t priv_len )

extern

Allocate UART.

Parameters

priv_len

Length of private data

Return values

uart	UART, or NULL on error

Definition at line 74 of file uart.c.

                                             {
        struct uart *uart;
 
        /* Allocate and initialise UART */
        uart = zalloc ( sizeof ( *uart ) + priv_len );
        if ( ! uart )
                return NULL;
        uart->priv = ( ( ( void * ) uart ) + sizeof ( *uart ) );
 
        return uart;
}

References NULL, uart::priv, and zalloc().

Referenced by dwuart_probe().

uart_register()

int uart_register ( struct uart * uart )

extern

Register UART.

Parameters

uart

UART

Return values

rc	Return status code

Definition at line 102 of file uart.c.

                                        {
 
        /* Add to list of registered UARTs */
        uart_get ( uart );
        list_add_tail ( &uart->list, &uarts );
        DBGC ( uart, "UART %s registered\n", uart->name );
 
        return 0;
}

References DBGC, uart::list, list_add_tail, uart::name, and uarts.

Referenced by dwuart_probe(), and uart_register_fixed().

uart_register_fixed()

int uart_register_fixed ( void )

extern

Register fixed UARTs (when not provided by platform)

Return values

rc	Return status code

Register fixed UARTs (when not provided by platform)

Return values

rc	Return status code

Definition at line 91 of file uart.c.

                                        {
 
        return 0;
}

References __weak, COM1, COM2, COM3, COM4, DBGC, name, rc, strerror(), and uart_register().

Referenced by uart_find().

uart_unregister()

void uart_unregister ( struct uart * uart )

extern

Unregister UART.

Parameters

uart

UART

Definition at line 117 of file uart.c.

                                           {
 
        /* Remove from list of registered UARTs */
        list_del ( &uart->list );
        uart_put ( uart );
}

References uart::list, and list_del.

Referenced by dwuart_probe(), and dwuart_remove().

uart_find()

struct uart * uart_find ( const char * name )

extern

Find named UART.

Parameters

name

UART name

Return values

uart	UART, or NULL if not found

Definition at line 130 of file uart.c.

                                             {
        struct uart *uart;
        unsigned int index;
        char *endp;
        int rc;
 
        /* Register fixed platform UARTs if not already registered */
        if ( list_empty ( &uarts ) ) {
                if ( ( rc = uart_register_fixed() ) != 0 ) {
                        DBGC ( &uarts, "UART could not register fixed UARTs: "
                               "%s\n", strerror ( rc ) );
                        /* Continue anyway */
                }
        }
 
        /* Try parsing name as a numeric index */
        index = strtoul ( name, &endp, 10 );
 
        /* Find matching UART, if any */
        list_for_each_entry ( uart, &uarts, list ) {
 
                /* Check for a matching name */
                if ( strcasecmp ( name, uart->name ) == 0 )
                        return uart;
 
                /* Check for a matching numeric index */
                if ( ( *endp == '\0' ) && ( index-- == 0 ) )
                        return uart;
        }
 
        DBGC ( &uarts, "UART %s not found\n", name );
        return NULL;
}

References DBGC, index, uart::list, list_empty, list_for_each_entry, name, uart::name, NULL, rc, strcasecmp(), strerror(), strtoul(), uart_register_fixed(), and uarts.

Referenced by gdbserial_configure().

Variable Documentation

byte

uint8_t byte

Initial value:

{
 
        uart->op->transmit ( uart, byte )

Definition at line 81 of file uart.h.

uarts

struct list_head uarts

extern

Referenced by fdtcon_default(), LIST_HEAD(), uart_find(), and uart_register().

null_uart_operations

struct uart_operations null_uart_operations

extern

Null UART operations.

Definition at line 60 of file uart.c.

                                              {
        .transmit = null_uart_transmit,
        .data_ready = null_uart_data_ready,
        .receive = null_uart_receive,
        .init = null_uart_init,
        .flush = null_uart_flush,
};