spcr.c File Reference

ACPI Serial Port Console Redirection (SPCR) More...

#include <errno.h>
#include <ipxe/serial.h>
#include <ipxe/pci.h>
#include <ipxe/ns16550.h>
#include <ipxe/spcr.h>

Go to the source code of this file.

Macros
#define	SERIAL_PREFIX_spcr   __spcr_
#define	SPCR_BAUD_BASE   115200
	Base baud rate for SPCR divisors. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
static int	spcr_16550 (struct spcr_table *spcr, struct uart *uart)
	Configure 16550-based serial console. More...
static struct uart *	spcr_console (void)
	Identify default serial console. More...
	PROVIDE_SERIAL (spcr, default_serial_console, spcr_console)

Variables
static struct uart	spcr_uart
	SPCR-defined UART. More...
static struct ns16550_uart	spcr_ns16550
	SPCR-defined 16550 UART. More...
static const uint8_t	spcr_baud_divisor [SPCR_BAUD_MAX]
	SPCR baud rate divisors. More...

Detailed Description

ACPI Serial Port Console Redirection (SPCR)

Definition in file spcr.c.

Macro Definition Documentation

SERIAL_PREFIX_spcr

#define SERIAL_PREFIX_spcr   __spcr_

Definition at line 41 of file spcr.c.

SPCR_BAUD_BASE

#define SPCR_BAUD_BASE   115200

Base baud rate for SPCR divisors.

Definition at line 56 of file spcr.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

spcr_16550()

static int spcr_16550 ( struct spcr_table *  spcr, struct uart *  uart  )

static

Configure 16550-based serial console.

Parameters

spcr	SPCR table
uart	UART to configure

Return values

rc	Return status code

Definition at line 76 of file spcr.c.

                                                                     {
        struct ns16550_uart *ns16550 = &spcr_ns16550;

        /* Set base address */
        ns16550->base = acpi_ioremap ( &spcr->base, NS16550_LEN );
        if ( ! ns16550->base ) {
                DBGC ( uart, "SPCR could not map registers\n" );
                return -ENODEV;
        }

        /* Set clock frequency, if specified */
        if ( spcr->clock )
                ns16550->clock = le32_to_cpu ( spcr->clock );

        /* Configure UART as a 16550 */
        uart->op = &ns16550_operations;
        uart->priv = ns16550;

        return 0;
}

References acpi_ioremap(), spcr_table::base, ns16550_uart::base, spcr_table::clock, ns16550_uart::clock, DBGC, ENODEV, le32_to_cpu, NS16550_LEN, ns16550_operations, uart::op, uart::priv, and spcr_ns16550.

Referenced by spcr_console().

spcr_console()

static struct uart* spcr_console ( void  )

static

Identify default serial console.

Return values

uart	Default serial console UART, or NULL

Definition at line 102 of file spcr.c.

                                           {
        struct uart *uart = &spcr_uart;
        struct spcr_table *spcr;
        unsigned int baud;
        int rc;

        /* Locate SPCR table */
        spcr = container_of ( acpi_table ( SPCR_SIGNATURE, 0 ),
                              struct spcr_table, acpi );
        if ( ! spcr ) {
                DBGC ( uart, "SPCR found no table\n" );
                goto err_table;
        }
        DBGC2 ( uart, "SPCR found table:\n" );
        DBGC2_HDA ( uart, 0, spcr, sizeof ( *spcr ) );
        DBGC ( uart, "SPCR is type %d at %02x:%08llx\n",
               spcr->type, spcr->base.type,
               ( ( unsigned long long ) le64_to_cpu ( spcr->base.address ) ) );
        if ( spcr->pci_vendor_id != cpu_to_le16 ( PCI_ANY_ID ) ) {
                DBGC ( uart, "SPCR is PCI " PCI_FMT " (%04x:%04x)\n",
                       spcr->pci_segment, spcr->pci_bus, spcr->pci_dev,
                       spcr->pci_func, le16_to_cpu ( spcr->pci_vendor_id ),
                       le16_to_cpu ( spcr->pci_device_id ) );
        }

        /* Get baud rate */
        baud = 0;
        if ( le32_to_cpu ( spcr->acpi.length ) >=
             ( offsetof ( typeof ( *spcr ), precise ) +
               sizeof ( spcr->precise ) ) ) {
                baud = le32_to_cpu ( spcr->precise );
                if ( baud )
                        DBGC ( uart, "SPCR has precise baud rate %d\n", baud );
        }
        if ( ( ! baud ) && spcr->baud && ( spcr->baud < SPCR_BAUD_MAX ) ) {
                baud = ( SPCR_BAUD_BASE / spcr_baud_divisor[spcr->baud] );
                DBGC ( uart, "SPCR has baud rate %d\n", baud );
        }
        uart->baud = baud;

        /* Initialise according to type */
        switch ( spcr->type ) {
        case SPCR_TYPE_16550:
        case SPCR_TYPE_16450:
        case SPCR_TYPE_16550_GAS:
                if ( ( rc = spcr_16550 ( spcr, uart ) ) != 0 )
                        goto err_type;
                break;
        default:
                DBGC ( uart, "SPCR unsupported type %d\n", spcr->type );
                goto err_type;
        }

        return uart;

 err_type:
 err_table:
        /* Fall back to using fixed serial console */
        return fixed_serial_console();
}

References spcr_table::acpi, acpi, acpi_table(), acpi_address::address, spcr_table::base, uart::baud, spcr_table::baud, container_of, cpu_to_le16, DBGC, DBGC2, DBGC2_HDA, fixed_serial_console(), le16_to_cpu, le32_to_cpu, le64_to_cpu, acpi_header::length, offsetof, PCI_ANY_ID, spcr_table::pci_bus, spcr_table::pci_dev, spcr_table::pci_device_id, PCI_FMT, spcr_table::pci_func, spcr_table::pci_segment, spcr_table::pci_vendor_id, spcr_table::precise, rc, spcr_16550(), SPCR_BAUD_BASE, spcr_baud_divisor, SPCR_BAUD_MAX, SPCR_SIGNATURE, SPCR_TYPE_16450, SPCR_TYPE_16550, SPCR_TYPE_16550_GAS, spcr_uart, spcr_table::type, acpi_address::type, and typeof().

PROVIDE_SERIAL()

PROVIDE_SERIAL	(	spcr	,
		default_serial_console	,
		spcr_console
	)

Variable Documentation

spcr_uart

struct uart spcr_uart

static

Initial value:

= {
        .refcnt = REF_INIT ( ref_no_free ),
        .name = "SPCR",
}

SPCR-defined UART.

Definition at line 45 of file spcr.c.

Referenced by spcr_console().

spcr_ns16550

struct ns16550_uart spcr_ns16550

static

Initial value:

= {
        .clock = NS16550_CLK_DEFAULT,
}

SPCR-defined 16550 UART.

Definition at line 51 of file spcr.c.

Referenced by spcr_16550().

spcr_baud_divisor

const uint8_t spcr_baud_divisor[SPCR_BAUD_MAX]

static

Initial value:

= {
        [SPCR_BAUD_2400] = ( SPCR_BAUD_BASE / 2400 ),
        [SPCR_BAUD_4800] = ( SPCR_BAUD_BASE / 4800 ),
        [SPCR_BAUD_9600] = ( SPCR_BAUD_BASE / 9600 ),
        [SPCR_BAUD_19200] = ( SPCR_BAUD_BASE / 19200 ),
        [SPCR_BAUD_38400] = ( SPCR_BAUD_BASE / 38400 ),
        [SPCR_BAUD_57600] = ( SPCR_BAUD_BASE / 57600 ),
        [SPCR_BAUD_115200] = ( SPCR_BAUD_BASE / 115200 ),
}

SPCR baud rate divisors.

Definition at line 59 of file spcr.c.

Referenced by spcr_console().