com32/hdt/hdt-common.h

   1 /* ----------------------------------------------------------------------- *
   2  *
   3  *   Copyright 2009 Erwan Velu - All Rights Reserved
   4  *
   5  *   Permission is hereby granted, free of charge, to any person
   6  *   obtaining a copy of this software and associated documentation
   7  *   files (the "Software"), to deal in the Software without
   8  *   restriction, including without limitation the rights to use,
   9  *   copy, modify, merge, publish, distribute, sublicense, and/or
  10  *   sell copies of the Software, and to permit persons to whom
  11  *   the Software is furnished to do so, subject to the following
  12  *   conditions:
  13  *
  14  *   The above copyright notice and this permission notice shall
  15  *   be included in all copies or substantial portions of the Software.
  16  *
  17  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  19  *   OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  20  *   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  21  *   HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  22  *   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23  *   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  24  *   OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  * -----------------------------------------------------------------------
  27  */
  28
  29 #ifndef DEFINE_HDT_COMMON_H
  30 #define DEFINE_HDT_COMMON_H
  31 #include <stdio.h>
  32 #include <syslinux/pxe.h>
  33 #include <console.h>
  34 #include <consoles.h>
  35 #include <syslinux/vesacon.h>
  36 #include "sys/pci.h"
  37
  38 #include <disk/bootloaders.h>
  39 #include <disk/errno_disk.h>
  40 #include <disk/error.h>
  41 #include <disk/geom.h>
  42 #include <disk/mbrs.h>
  43 #include <disk/msdos.h>
  44 #include <disk/partition.h>
  45 #include <disk/swsusp.h>
  46 #include <disk/read.h>
  47
  48 #include "cpuid.h"
  49 #include "dmi/dmi.h"
  50 #include "hdt-ata.h"
  51 #include <lib/sys/vesa/vesa.h>
  52 #include <vpd/vpd.h>
  53 #include <libansi.h>
  54 #include <acpi/acpi.h>
  55 #include <libupload/upload_backend.h>
  56
  57 /* Declare a variable or data structure as unused. */
  58 #define __unused __attribute__ (( unused ))
  59
  60 /* This two values are used for switching for the menu to the CLI mode */
  61 #define HDT_SWITCH_TO_CLI "hdt_switch_to_cli"
  62 #define HDT_DUMP "hdt_dump"
  63 #define HDT_RETURN_TO_CLI 100
  64 #define MAX_VESA_MODES 255
  65
  66 /* This value is used for rebooting from the menu mode */
  67 #define HDT_REBOOT "hdt_reboot"
  68
  69 /* The maximum number of commands we can process */
  70 #define MAX_NB_AUTO_COMMANDS 255
  71 /* The maximum size of a command */
  72 #define AUTO_COMMAND_SIZE 255
  73 /* The char that separate two commands */
  74 #define AUTO_SEPARATOR ";"
  75 /* The char that surround the list of commands */
  76 #define AUTO_DELIMITER '\''
  77
  78 /* Graphic to load in background when using the vesa mode */
  79 #define CLI_DEFAULT_BACKGROUND "backgnd.png"
  80
  81 /* The maximum number of lines */
  82 #define MAX_CLI_LINES 20
  83 #define MAX_VESA_CLI_LINES 24
  84
  85 struct upload_backend *upload;
  86
  87 /* Defines if the cli is quiet*/
  88 bool quiet;
  89
  90 /* Defines if we must use the vesa mode */
  91 bool vesamode;
  92
  93 /* Defines if we must use the menu mode */
  94 bool menumode;
  95
  96 /* Defines if we are running the auto mode */
  97 bool automode;
  98
  99 /* Defines the number of lines in the console
 100  * Default is 20 for a std console */
 101 extern int max_console_lines;
 102
 103 extern int display_line_nb;
 104 extern bool disable_more_printf;
 105
 106 #define pause_printf() do {\
 107        printf("--More--");\
 108        get_key(stdin, 0);\
 109        printf("\033[2K\033[1G\033[1F\n");\
 110 } while (0);
 111
 112 /* The brokeness of that macro is that
 113  * it assumes that __VA_ARGS__ contains
 114  * one \n (and only one)
 115  */
 116 #define more_printf(...) do {\
 117  if (__likely(!disable_more_printf)) {\
 118   if (display_line_nb == max_console_lines) {\
 119    display_line_nb=0;\
 120    printf("\n--More--");\
 121    get_key(stdin, 0);\
 122    printf("\033[2K\033[1G\033[1F");\
 123   }\
 124   display_line_nb++;\
 125  }\
 126  printf(__VA_ARGS__);\
 127 } while (0);
 128
 129 /* Display CPU registers for debugging purposes */
 130 static inline void printregs(const com32sys_t * r)
 131 {
 132     printf("eflags = %08x  ds = %04x  es = %04x  fs = %04x  gs = %04x\n"
 133            "eax = %08x  ebx = %08x  ecx = %08x  edx = %08x\n"
 134            "ebp = %08x  esi = %08x  edi = %08x  esp = %08x\n",
 135            r->eflags.l, r->ds, r->es, r->fs, r->gs,
 136            r->eax.l, r->ebx.l, r->ecx.l, r->edx.l,
 137            r->ebp.l, r->esi.l, r->edi.l, r->_unused_esp.l);
 138 }
 139
 140 struct s_pxe {
 141     uint16_t vendor_id;
 142     uint16_t product_id;
 143     uint16_t subvendor_id;
 144     uint16_t subproduct_id;
 145     uint8_t rev;
 146     uint8_t pci_bus;
 147     uint8_t pci_dev;
 148     uint8_t pci_func;
 149     uint8_t base_class;
 150     uint8_t sub_class;
 151     uint8_t prog_intf;
 152     uint8_t nictype;
 153     char mac_addr[18];          /* The current mac address */
 154     uint8_t ip_addr[4];
 155     pxe_bootp_t dhcpdata;       /* The dhcp answer */
 156     struct pci_device *pci_device;      /* The matching pci device */
 157     uint8_t pci_device_pos;     /* It position in our pci sorted list */
 158 };
 159
 160 struct s_vesa_mode_info {
 161     struct vesa_mode_info mi;
 162     uint16_t mode;
 163 };
 164
 165 struct s_vesa {
 166     uint8_t major_version;
 167     uint8_t minor_version;
 168     struct s_vesa_mode_info vmi[MAX_VESA_MODES];
 169     uint8_t vmi_count;
 170     uint16_t total_memory;
 171     char vendor[256];
 172     char product[256];
 173     char product_revision[256];
 174     uint16_t software_rev;
 175 };
 176
 177 struct s_hardware {
 178     s_dmi dmi;                  /* DMI table */
 179     s_cpu cpu;                  /* CPU information */
 180     uint8_t physical_cpu_count; /* Number of physical cpu */
 181     s_vpd vpd;                  /* VPD information */
 182     s_acpi acpi;
 183     struct pci_domain *pci_domain;      /* PCI Devices */
 184     struct driveinfo disk_info[256];    /* Disk Information */
 185     uint32_t mbr_ids[256];      /* MBR ids */
 186     int disks_count;            /* Number of detected disks */
 187     struct s_pxe pxe;
 188     struct s_vesa vesa;
 189     unsigned long detected_memory_size; /* The detected memory size (in KB) */
 190
 191     int pci_ids_return_code;
 192     int modules_pcimap_return_code;
 193     int modules_alias_return_code;
 194     int nb_pci_devices;
 195     bool is_dmi_valid;
 196     bool is_pxe_valid;
 197     bool is_vesa_valid;
 198     bool is_vpd_valid;
 199     bool is_acpi_valid;
 200
 201     bool dmi_detection;         /* Does the dmi stuff has already been detected? */
 202     bool pci_detection;         /* Does the pci stuff has already been detected? */
 203     bool cpu_detection;         /* Does the cpu stuff has already been detected? */
 204     bool disk_detection;        /* Does the disk stuff has already been detected? */
 205     bool pxe_detection;         /* Does the pxe stuff has already been detected? */
 206     bool vesa_detection;        /* Does the vesa sutff have been already detected? */
 207     bool vpd_detection;         /* Does the vpd stuff has already been detected? */
 208     bool memory_detection;      /* Does the memory size got detected ?*/
 209     bool acpi_detection;        /* Does the acpi got detected ?*/
 210
 211     char syslinux_fs[22];
 212     const struct syslinux_version *sv;
 213     char modules_pcimap_path[255];
 214     char modules_alias_path[255];
 215     char pciids_path[255];
 216     char dump_path[255]; /* Dump path on the tftp server */
 217     char dump_filename[255]; /* Dump filename on the tftp server */
 218     char tftp_ip[255];   /* IP address of tftp server (dump mode) */
 219     char memtest_label[255];
 220     char auto_label[AUTO_COMMAND_SIZE];
 221     char vesa_background[255];
 222     char postexec[255];
 223 };
 224
 225 void reset_more_printf(void);
 226 const char *find_argument(const char **argv, const char *argument);
 227 char *remove_spaces(char *p);
 228 char *remove_trailing_lf(char *p);
 229 char *skip_spaces(char *p);
 230 char *del_multi_spaces(char *p);
 231 int detect_dmi(struct s_hardware *hardware);
 232 int detect_vpd(struct s_hardware *hardware);
 233 void detect_disks(struct s_hardware *hardware);
 234 void detect_pci(struct s_hardware *hardware);
 235 void cpu_detect(struct s_hardware *hardware);
 236 int detect_pxe(struct s_hardware *hardware);
 237 void init_hardware(struct s_hardware *hardware);
 238 void clear_screen(void);
 239 void detect_syslinux(struct s_hardware *hardware);
 240 int detect_acpi(struct s_hardware *hardware);
 241 void detect_parameters(const int argc, const char *argv[],
 242                        struct s_hardware *hardware);
 243 int detect_vesa(struct s_hardware *hardware);
 244 void detect_memory(struct s_hardware *hardware);
 245 void init_console(struct s_hardware *hardware);
 246 void detect_hardware(struct s_hardware *hardware);
 247 void dump(struct s_hardware *hardware);
 248 #endif