sys/dev/uart/uart_cpu_arm64.c

   1 /*-
   2  * Copyright (c) 2016 The FreeBSD Foundation
   3  * All rights reserved.
   4  *
   5  * This software was developed by Andrew Turner under sponsorship from
   6  * the FreeBSD Foundation.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #include "opt_acpi.h"
  31 #include "opt_platform.h"
  32
  33 #include <sys/cdefs.h>
  34 __FBSDID("$FreeBSD$");
  35
  36 #include <sys/param.h>
  37 #include <sys/bus.h>
  38 #include <sys/kernel.h>
  39 #include <sys/module.h>
  40 #include <sys/systm.h>
  41
  42 #include <vm/vm.h>
  43 #include <vm/pmap.h>
  44
  45 #include <machine/bus.h>
  46
  47 #include <dev/uart/uart.h>
  48 #include <dev/uart/uart_bus.h>
  49 #include <dev/uart/uart_cpu.h>
  50
  51 #ifdef DEV_ACPI
  52 #include <contrib/dev/acpica/include/acpi.h>
  53 #include <contrib/dev/acpica/include/accommon.h>
  54 #include <contrib/dev/acpica/include/actables.h>
  55 #include <dev/uart/uart_cpu_acpi.h>
  56 #endif
  57
  58 #ifdef FDT
  59 #include <dev/fdt/fdt_common.h>
  60 #include <dev/ofw/ofw_bus.h>
  61 #include <dev/ofw/ofw_bus_subr.h>
  62 #include <dev/uart/uart_cpu_fdt.h>
  63 #endif
  64
  65 /*
  66  * UART console routines.
  67  */
  68 bus_space_tag_t uart_bus_space_io;
  69 bus_space_tag_t uart_bus_space_mem;
  70
  71 int
  72 uart_cpu_eqres(struct uart_bas *b1, struct uart_bas *b2)
  73 {
  74
  75         if (pmap_kextract(b1->bsh) == 0)
  76                 return (0);
  77         if (pmap_kextract(b2->bsh) == 0)
  78                 return (0);
  79         return ((pmap_kextract(b1->bsh) == pmap_kextract(b2->bsh)) ? 1 : 0);
  80 }
  81
  82 #ifdef DEV_ACPI
  83 static struct acpi_uart_compat_data *
  84 uart_cpu_acpi_scan(uint8_t interface_type)
  85 {
  86         struct acpi_uart_compat_data **cd, *curcd;
  87         int i;
  88
  89         SET_FOREACH(cd, uart_acpi_class_and_device_set) {
  90                 curcd = *cd;
  91                 for (i = 0; curcd[i].hid != NULL; i++) {
  92                         if (curcd[i].port_subtype == interface_type)
  93                                 return (&curcd[i]);
  94                 }
  95         }
  96
  97         SET_FOREACH(cd, uart_acpi_class_set) {
  98                 curcd = *cd;
  99                 for (i = 0; curcd[i].hid != NULL; i++) {
 100                         if (curcd[i].port_subtype == interface_type)
 101                                 return (&curcd[i]);
 102                 }
 103         }
 104
 105         return (NULL);
 106 }
 107
 108 static int
 109 uart_cpu_acpi_probe(struct uart_class **classp, bus_space_tag_t *bst,
 110     bus_space_handle_t *bsh, int *baud, u_int *rclk, u_int *shiftp,
 111     u_int *iowidthp)
 112 {
 113         struct acpi_uart_compat_data *cd;
 114         ACPI_TABLE_SPCR *spcr;
 115         vm_paddr_t spcr_physaddr;
 116         int err;
 117
 118         err = ENXIO;
 119         spcr_physaddr = acpi_find_table(ACPI_SIG_SPCR);
 120         if (spcr_physaddr == 0)
 121                 return (ENXIO);
 122
 123         spcr = acpi_map_table(spcr_physaddr, ACPI_SIG_SPCR);
 124
 125         cd = uart_cpu_acpi_scan(spcr->InterfaceType);
 126         if (cd == NULL)
 127                 goto out;
 128
 129         switch(spcr->BaudRate) {
 130         case 3:
 131                 *baud = 9600;
 132                 break;
 133         case 4:
 134                 *baud = 19200;
 135                 break;
 136         case 6:
 137                 *baud = 57600;
 138                 break;
 139         case 7:
 140                 *baud = 115200;
 141                 break;
 142         default:
 143                 goto out;
 144         }
 145
 146         err = acpi_map_addr(&spcr->SerialPort, bst, bsh, PAGE_SIZE);
 147         if (err != 0)
 148                 goto out;
 149
 150         *classp = cd->clas;
 151         *rclk = 0;
 152         *shiftp = 2;
 153         *iowidthp = spcr->SerialPort.BitWidth / 8;
 154
 155 out:
 156         acpi_unmap_table(spcr);
 157         return (err);
 158 }
 159 #endif
 160
 161 int
 162 uart_cpu_getdev(int devtype, struct uart_devinfo *di)
 163 {
 164         struct uart_class *class;
 165         bus_space_handle_t bsh;
 166         bus_space_tag_t bst;
 167         u_int rclk, shift, iowidth;
 168         int br, err;
 169
 170         /* Allow overriding the FDT using the environment. */
 171         class = &uart_ns8250_class;
 172         err = uart_getenv(devtype, di, class);
 173         if (err == 0)
 174                 return (0);
 175
 176         if (devtype != UART_DEV_CONSOLE)
 177                 return (ENXIO);
 178
 179         err = ENXIO;
 180 #ifdef DEV_ACPI
 181         err = uart_cpu_acpi_probe(&class, &bst, &bsh, &br, &rclk, &shift,
 182             &iowidth);
 183 #endif
 184 #ifdef FDT
 185         if (err != 0) {
 186                 err = uart_cpu_fdt_probe(&class, &bst, &bsh, &br, &rclk,
 187                     &shift, &iowidth);
 188         }
 189 #endif
 190         if (err != 0)
 191                 return (err);
 192
 193         /*
 194          * Finalize configuration.
 195          */
 196         di->bas.chan = 0;
 197         di->bas.regshft = shift;
 198         di->bas.regiowidth = iowidth;
 199         di->baudrate = br;
 200         di->bas.rclk = rclk;
 201         di->ops = uart_getops(class);
 202         di->databits = 8;
 203         di->stopbits = 1;
 204         di->parity = UART_PARITY_NONE;
 205         di->bas.bst = bst;
 206         di->bas.bsh = bsh;
 207         uart_bus_space_mem = di->bas.bst;
 208         uart_bus_space_io = NULL;
 209
 210         return (0);
 211 }