uart.c File Reference

Generic UARTs. More...

#include <stdlib.h>
#include <strings.h>
#include <errno.h>
#include <ipxe/uart.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	LIST_HEAD (uarts)
	List of registered UARTs. More...
static void	null_uart_transmit (struct uart *uart __unused, uint8_t byte __unused)
static int	null_uart_data_ready (struct uart *uart __unused)
static uint8_t	null_uart_receive (struct uart *uart __unused)
static int	null_uart_init (struct uart *uart __unused)
static void	null_uart_flush (struct uart *uart __unused)
struct uart *	alloc_uart (size_t priv_len)
	Allocate UART. More...
__weak int	uart_register_fixed (void)
	Register fixed UARTs (when not provided by platform) More...
int	uart_register (struct uart *uart)
	Register UART. More...
void	uart_unregister (struct uart *uart)
	Unregister UART. More...
struct uart *	uart_find (const char *name)
	Find named UART. More...

Variables
struct uart_operations	null_uart_operations
	Null UART operations. More...

Detailed Description

Generic UARTs.

Definition in file uart.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

LIST_HEAD()

LIST_HEAD

(

uarts

)

List of registered UARTs.

null_uart_transmit()

static void null_uart_transmit ( struct uart *uart  __unused, uint8_t byte  __unused  )

static

Definition at line 40 of file uart.c.

                                                         {
}

null_uart_data_ready()

static int null_uart_data_ready ( struct uart *uart  __unused )

static

Definition at line 44 of file uart.c.

                                                               {
        return 0;
}

null_uart_receive()

static uint8_t null_uart_receive ( struct uart *uart  __unused )

static

Definition at line 48 of file uart.c.

                                                                {
        return 0;
}

null_uart_init()

static int null_uart_init ( struct uart *uart  __unused )

static

Definition at line 52 of file uart.c.

                                                         {
        return 0;
}

null_uart_flush()

static void null_uart_flush ( struct uart *uart  __unused )

static

Definition at line 56 of file uart.c.

                                                           {
}

alloc_uart()

struct uart* alloc_uart

(

size_t

priv_len

)

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_fixed()

__weak int uart_register_fixed

(

void

)

Register fixed UARTs (when not provided by platform)

Return values

rc	Return status code

Definition at line 91 of file uart.c.

                                        {

        return 0;
}

Referenced by uart_find().

uart_register()

int uart_register

(

struct uart *

uart

)

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_unregister()

void uart_unregister

(

struct uart *

uart

)

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

)

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, uart::name, name, NULL, rc, strcasecmp(), strerror(), strtoul(), uart_register_fixed(), and uarts.

Referenced by gdbserial_configure().

Variable Documentation

null_uart_operations

struct uart_operations null_uart_operations

Initial value:

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

Null UART operations.

Definition at line 60 of file uart.c.