sys/dev/uart/uart_cpu_fdt.c

   1 /*-
   2  * Copyright (c) 2009-2010 The FreeBSD Foundation
   3  * All rights reserved.
   4  *
   5  * This software was developed by Semihalf 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 <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include <sys/param.h>
  34 #include <sys/bus.h>
  35 #include <sys/kernel.h>
  36 #include <sys/module.h>
  37 #include <sys/systm.h>
  38
  39 #include <vm/vm.h>
  40 #include <vm/pmap.h>
  41
  42 #include <machine/bus.h>
  43 #include <machine/fdt.h>
  44
  45 #include <dev/fdt/fdt_common.h>
  46 #include <dev/ofw/ofw_bus.h>
  47 #include <dev/ofw/ofw_bus_subr.h>
  48 #include <dev/uart/uart.h>
  49 #include <dev/uart/uart_bus.h>
  50 #include <dev/uart/uart_cpu.h>
  51
  52 /*
  53  * UART console routines.
  54  */
  55 bus_space_tag_t uart_bus_space_io;
  56 bus_space_tag_t uart_bus_space_mem;
  57
  58 static int
  59 uart_fdt_get_clock(phandle_t node, pcell_t *cell)
  60 {
  61         pcell_t clock;
  62
  63         if ((OF_getprop(node, "clock-frequency", &clock,
  64             sizeof(clock))) <= 0)
  65                 return (ENXIO);
  66
  67         if (clock == 0)
  68                 /* Try to retrieve parent 'bus-frequency' */
  69                 /* XXX this should go to simple-bus fixup or so */
  70                 if ((OF_getprop(OF_parent(node), "bus-frequency", &clock,
  71                     sizeof(clock))) <= 0)
  72                         clock = 0;
  73
  74         *cell = fdt32_to_cpu(clock);
  75         return (0);
  76 }
  77
  78 static int
  79 uart_fdt_get_shift(phandle_t node, pcell_t *cell)
  80 {
  81         pcell_t shift;
  82
  83         if ((OF_getprop(node, "reg-shift", &shift, sizeof(shift))) <= 0)
  84                 shift = 0;
  85         *cell = fdt32_to_cpu(shift);
  86         return (0);
  87 }
  88
  89 int
  90 uart_cpu_eqres(struct uart_bas *b1, struct uart_bas *b2)
  91 {
  92
  93         if (b1->bst != b2->bst)
  94                 return (0);
  95         if (pmap_kextract(b1->bsh) == 0)
  96                 return (0);
  97         if (pmap_kextract(b2->bsh) == 0)
  98                 return (0);
  99         return ((pmap_kextract(b1->bsh) == pmap_kextract(b2->bsh)) ? 1 : 0);
 100 }
 101
 102 static int
 103 phandle_chosen_propdev(phandle_t chosen, const char *name, phandle_t *node)
 104 {
 105         char buf[64];
 106
 107         if (OF_getprop(chosen, name, buf, sizeof(buf)) <= 0)
 108                 return (ENXIO);
 109         if ((*node = OF_finddevice(buf)) == -1)
 110                 return (ENXIO);
 111
 112         return (0);
 113 }
 114
 115 int
 116 uart_cpu_getdev(int devtype, struct uart_devinfo *di)
 117 {
 118         const char *propnames[] = {"stdout-path", "linux,stdout-path", "stdout",
 119             "stdin-path", "stdin", NULL};
 120         const char **name;
 121         struct uart_class *class;
 122         phandle_t node, chosen;
 123         pcell_t shift, br, rclk;
 124         u_long start, size, pbase, psize;
 125         int err;
 126
 127         uart_bus_space_mem = fdtbus_bs_tag;
 128         uart_bus_space_io = NULL;
 129
 130         /* Allow overriding the FDT using the environment. */
 131         class = &uart_ns8250_class;
 132         err = uart_getenv(devtype, di, class);
 133         if (!err)
 134                 return (0);
 135
 136         if (devtype != UART_DEV_CONSOLE)
 137                 return (ENXIO);
 138
 139         /*
 140          * Retrieve /chosen/std{in,out}.
 141          */
 142         node = -1;
 143         if ((chosen = OF_finddevice("/chosen")) != -1) {
 144                 for (name = propnames; *name != NULL; name++) {
 145                         if (phandle_chosen_propdev(chosen, *name, &node) == 0)
 146                                 break;
 147                 }
 148         }
 149         if (chosen == -1 || *name == NULL)
 150                 node = OF_finddevice("serial0"); /* Last ditch */
 151
 152         if (node == -1) /* Can't find anything */
 153                 return (ENXIO);
 154
 155         /*
 156          * Retrieve serial attributes.
 157          */
 158         uart_fdt_get_shift(node, &shift);
 159
 160         if (OF_getprop(node, "current-speed", &br, sizeof(br)) <= 0)
 161                 br = 0;
 162         br = fdt32_to_cpu(br);
 163
 164         if ((err = uart_fdt_get_clock(node, &rclk)) != 0)
 165                 return (err);
 166         /*
 167          * Finalize configuration.
 168          */
 169         if (fdt_is_compatible(node, "fsl,imx-uart"))
 170                 class = &uart_imx_class;
 171         else if (fdt_is_compatible(node, "quicc"))
 172                 class = &uart_quicc_class;
 173         else if (fdt_is_compatible(node, "lpc"))
 174                 class = &uart_lpc_class;
 175         else if (fdt_is_compatible(node, "arm,pl011"))
 176                 class = &uart_pl011_class;
 177         else if (fdt_is_compatible(node, "exynos"))
 178                 class = &uart_s3c2410_class;
 179         else if (fdt_is_compatible(node, "cadence,uart"))
 180                 class = &uart_cdnc_class;
 181         else if (fdt_is_compatible(node, "ti,ns16550"))
 182                 class = &uart_ti8250_class;
 183         else if (fdt_is_compatible(node, "ns16550"))
 184                 class = &uart_ns8250_class;
 185
 186         di->bas.chan = 0;
 187         di->bas.regshft = (u_int)shift;
 188         di->baudrate = br;
 189         di->bas.rclk = (u_int)rclk;
 190         di->ops = uart_getops(class);
 191         di->databits = 8;
 192         di->stopbits = 1;
 193         di->parity = UART_PARITY_NONE;
 194         di->bas.bst = uart_bus_space_mem;
 195
 196         err = fdt_regsize(node, &start, &size);
 197         if (err)
 198                 return (ENXIO);
 199         err = fdt_get_range(OF_parent(node), 0, &pbase, &psize);
 200         if (err)
 201                 pbase = 0;
 202
 203         start += pbase;
 204
 205         return (bus_space_map(di->bas.bst, start, size, 0, &di->bas.bsh));
 206 }