arch/all-pc/boot/grub2-aros/include/grub/serial.h

   1 /* serial.h - serial device interface */
   2 /*
   3  *  GRUB  --  GRand Unified Bootloader
   4  *  Copyright (C) 2010  Free Software Foundation, Inc.
   5  *
   6  *  GRUB is free software: you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation, either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  GRUB is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef GRUB_SERIAL_HEADER
  21 #define GRUB_SERIAL_HEADER      1
  22
  23 #include <grub/types.h>
  24 #if defined(__mips__) || defined (__i386__) || defined (__x86_64__)
  25 #include <grub/cpu/io.h>
  26 #endif
  27 #include <grub/usb.h>
  28 #include <grub/list.h>
  29 #include <grub/term.h>
  30 #ifdef GRUB_MACHINE_IEEE1275
  31 #include <grub/ieee1275/ieee1275.h>
  32 #endif
  33
  34 struct grub_serial_port;
  35 struct grub_serial_config;
  36
  37 struct grub_serial_driver
  38 {
  39   grub_err_t (*configure) (struct grub_serial_port *port,
  40                            struct grub_serial_config *config);
  41   int (*fetch) (struct grub_serial_port *port);
  42   void (*put) (struct grub_serial_port *port, const int c);
  43   void (*fini) (struct grub_serial_port *port);
  44 };
  45
  46 /* The type of parity.  */
  47 typedef enum
  48   {
  49     GRUB_SERIAL_PARITY_NONE,
  50     GRUB_SERIAL_PARITY_ODD,
  51     GRUB_SERIAL_PARITY_EVEN,
  52   } grub_serial_parity_t;
  53
  54 typedef enum
  55   {
  56     GRUB_SERIAL_STOP_BITS_1,
  57     GRUB_SERIAL_STOP_BITS_1_5,
  58     GRUB_SERIAL_STOP_BITS_2,
  59   } grub_serial_stop_bits_t;
  60
  61 struct grub_serial_config
  62 {
  63   unsigned speed;
  64   int word_len;
  65   grub_serial_parity_t parity;
  66   grub_serial_stop_bits_t stop_bits;
  67 };
  68
  69 struct grub_serial_port
  70 {
  71   struct grub_serial_port *next;
  72   struct grub_serial_port **prev;
  73   char *name;
  74   struct grub_serial_driver *driver;
  75   struct grub_serial_config config;
  76   int configured;
  77   int broken;
  78
  79   /* This should be void *data but since serial is useful as an early console
  80      when malloc isn't available it's a union.
  81    */
  82   union
  83   {
  84 #if defined(__mips__) || defined (__i386__) || defined (__x86_64__)
  85     grub_port_t port;
  86 #endif
  87     struct
  88     {
  89       grub_usb_device_t usbdev;
  90       int configno;
  91       int interfno;
  92       char buf[64];
  93       int bufstart, bufend;
  94       struct grub_usb_desc_endp *in_endp;
  95       struct grub_usb_desc_endp *out_endp;
  96     };
  97     struct grub_escc_descriptor *escc_desc;
  98 #ifdef GRUB_MACHINE_IEEE1275
  99     struct
 100     {
 101       grub_ieee1275_ihandle_t handle;
 102       struct ofserial_hash_ent *elem;
 103     };
 104 #endif
 105 #ifdef GRUB_MACHINE_EFI
 106     struct grub_efi_serial_io_interface *interface;
 107 #endif
 108   };
 109   grub_term_output_t term_out;
 110   grub_term_input_t term_in;
 111 };
 112
 113 grub_err_t EXPORT_FUNC(grub_serial_register) (struct grub_serial_port *port);
 114
 115 void EXPORT_FUNC(grub_serial_unregister) (struct grub_serial_port *port);
 116
 117   /* Convenience functions to perform primitive operations on a port.  */
 118 static inline grub_err_t
 119 grub_serial_port_configure (struct grub_serial_port *port,
 120                             struct grub_serial_config *config)
 121 {
 122   return port->driver->configure (port, config);
 123 }
 124
 125 static inline int
 126 grub_serial_port_fetch (struct grub_serial_port *port)
 127 {
 128   return port->driver->fetch (port);
 129 }
 130
 131 static inline void
 132 grub_serial_port_put (struct grub_serial_port *port, const int c)
 133 {
 134   port->driver->put (port, c);
 135 }
 136
 137 static inline void
 138 grub_serial_port_fini (struct grub_serial_port *port)
 139 {
 140   port->driver->fini (port);
 141 }
 142
 143   /* Set default settings.  */
 144 static inline grub_err_t
 145 grub_serial_config_defaults (struct grub_serial_port *port)
 146 {
 147   struct grub_serial_config config =
 148     {
 149 #ifdef GRUB_MACHINE_MIPS_LOONGSON
 150       .speed = 115200,
 151 #else
 152       .speed = 9600,
 153 #endif
 154       .word_len = 8,
 155       .parity = GRUB_SERIAL_PARITY_NONE,
 156       .stop_bits = GRUB_SERIAL_STOP_BITS_1
 157     };
 158
 159   return port->driver->configure (port, &config);
 160 }
 161
 162 #if defined(__mips__) || defined (__i386__) || defined (__x86_64__)
 163 void grub_ns8250_init (void);
 164 char *grub_serial_ns8250_add_port (grub_port_t port);
 165 #endif
 166 #ifdef GRUB_MACHINE_IEEE1275
 167 void grub_ofserial_init (void);
 168 #endif
 169 #ifdef GRUB_MACHINE_EFI
 170 void
 171 grub_efiserial_init (void);
 172 #endif
 173
 174 struct grub_serial_port *grub_serial_find (const char *name);
 175 extern struct grub_serial_driver grub_ns8250_driver;
 176 void EXPORT_FUNC(grub_serial_unregister_driver) (struct grub_serial_driver *driver);
 177
 178 #ifndef GRUB_MACHINE_EMU
 179 extern void grub_serial_init (void);
 180 extern void grub_serial_fini (void);
 181 #endif
 182
 183 #endif