pc-bios/s390-ccw/s390-ccw.h

   1 /*
   2  * S390 CCW boot loader
   3  *
   4  * Copyright (c) 2013 Alexander Graf <agraf@suse.de>
   5  *
   6  * This work is licensed under the terms of the GNU GPL, version 2 or (at
   7  * your option) any later version. See the COPYING file in the top-level
   8  * directory.
   9  */
  10
  11 #ifndef S390_CCW_H
  12 #define S390_CCW_H
  13
  14 /* #define DEBUG */
  15
  16 typedef unsigned char      u8;
  17 typedef unsigned short     u16;
  18 typedef unsigned int       u32;
  19 typedef unsigned long long u64;
  20 typedef unsigned long      ulong;
  21 typedef unsigned char      __u8;
  22 typedef unsigned short     __u16;
  23 typedef unsigned int       __u32;
  24 typedef unsigned long long __u64;
  25
  26 #define true 1
  27 #define false 0
  28 #define PAGE_SIZE 4096
  29
  30 #ifndef EIO
  31 #define EIO     1
  32 #endif
  33 #ifndef EBUSY
  34 #define EBUSY   2
  35 #endif
  36 #ifndef NULL
  37 #define NULL    0
  38 #endif
  39 #ifndef MIN
  40 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
  41 #endif
  42 #ifndef MIN_NON_ZERO
  43 #define MIN_NON_ZERO(a, b) ((a) == 0 ? (b) : \
  44                             ((b) == 0 ? (a) : (MIN(a, b))))
  45 #endif
  46
  47 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  48
  49 #include "cio.h"
  50 #include "iplb.h"
  51
  52 typedef struct irb Irb;
  53 typedef struct ccw1 Ccw1;
  54 typedef struct cmd_orb CmdOrb;
  55 typedef struct schib Schib;
  56 typedef struct chsc_area_sda ChscAreaSda;
  57 typedef struct senseid SenseId;
  58 typedef struct subchannel_id SubChannelId;
  59
  60 /* start.s */
  61 void disabled_wait(void);
  62 void consume_sclp_int(void);
  63
  64 /* main.c */
  65 void panic(const char *string);
  66 void write_subsystem_identification(void);
  67 extern char stack[PAGE_SIZE * 8] __attribute__((__aligned__(PAGE_SIZE)));
  68 unsigned int get_loadparm_index(void);
  69
  70 /* sclp.c */
  71 void sclp_print(const char *string);
  72 void sclp_set_write_mask(uint32_t receive_mask, uint32_t send_mask);
  73 void sclp_setup(void);
  74 void sclp_get_loadparm_ascii(char *loadparm);
  75 int sclp_read(char *str, size_t count);
  76
  77 /* virtio.c */
  78 unsigned long virtio_load_direct(ulong rec_list1, ulong rec_list2,
  79                                  ulong subchan_id, void *load_addr);
  80 bool virtio_is_supported(SubChannelId schid);
  81 void virtio_blk_setup_device(SubChannelId schid);
  82 int virtio_read(ulong sector, void *load_addr);
  83 int enable_mss_facility(void);
  84 u64 get_clock(void);
  85 ulong get_second(void);
  86
  87 /* bootmap.c */
  88 void zipl_load(void);
  89
  90 /* jump2ipl.c */
  91 void jump_to_IPL_code(uint64_t address);
  92 void jump_to_low_kernel(void);
  93
  94 /* menu.c */
  95 void menu_set_parms(uint8_t boot_menu_flag, uint32_t boot_menu_timeout);
  96 int menu_get_zipl_boot_index(const char *menu_data);
  97 bool menu_is_enabled_zipl(void);
  98 int menu_get_enum_boot_index(bool *valid_entries);
  99 bool menu_is_enabled_enum(void);
 100
 101 #define MAX_BOOT_ENTRIES  31
 102
 103 static inline void fill_hex(char *out, unsigned char val)
 104 {
 105     const char hex[] = "0123456789abcdef";
 106
 107     out[0] = hex[(val >> 4) & 0xf];
 108     out[1] = hex[val & 0xf];
 109 }
 110
 111 static inline void fill_hex_val(char *out, void *ptr, unsigned size)
 112 {
 113     unsigned char *value = ptr;
 114     unsigned int i;
 115
 116     for (i = 0; i < size; i++) {
 117         fill_hex(&out[i*2], value[i]);
 118     }
 119 }
 120
 121 static inline void print_int(const char *desc, u64 addr)
 122 {
 123     char out[] = ": 0xffffffffffffffff\n";
 124
 125     fill_hex_val(&out[4], &addr, sizeof(addr));
 126
 127     sclp_print(desc);
 128     sclp_print(out);
 129 }
 130
 131 static inline void debug_print_int(const char *desc, u64 addr)
 132 {
 133 #ifdef DEBUG
 134     print_int(desc, addr);
 135 #endif
 136 }
 137
 138 static inline void debug_print_addr(const char *desc, void *p)
 139 {
 140 #ifdef DEBUG
 141     debug_print_int(desc, (unsigned int)(unsigned long)p);
 142 #endif
 143 }
 144
 145 /***********************************************
 146  *           Hypercall functions               *
 147  ***********************************************/
 148
 149 #define KVM_S390_VIRTIO_NOTIFY          0
 150 #define KVM_S390_VIRTIO_RESET           1
 151 #define KVM_S390_VIRTIO_SET_STATUS      2
 152 #define KVM_S390_VIRTIO_CCW_NOTIFY      3
 153
 154 static inline void yield(void)
 155 {
 156     asm volatile ("diag 0,0,0x44"
 157                   : :
 158                   : "memory", "cc");
 159 }
 160
 161 #define MAX_SECTOR_SIZE 4096
 162
 163 static inline void sleep(unsigned int seconds)
 164 {
 165     ulong target = get_second() + seconds;
 166
 167     while (get_second() < target) {
 168         yield();
 169     }
 170 }
 171
 172 static inline void IPL_assert(bool term, const char *message)
 173 {
 174     if (!term) {
 175         sclp_print("\n! ");
 176         sclp_print(message);
 177         panic(" !\n"); /* no return */
 178     }
 179 }
 180
 181 static inline void IPL_check(bool term, const char *message)
 182 {
 183     if (!term) {
 184         sclp_print("\n! WARNING: ");
 185         sclp_print(message);
 186         sclp_print(" !\n");
 187     }
 188 }
 189
 190 extern const unsigned char ebc2asc[256];
 191 static inline void ebcdic_to_ascii(const char *src,
 192                                    char *dst,
 193                                    unsigned int size)
 194 {
 195     unsigned int i;
 196
 197     for (i = 0; i < size; i++) {
 198         unsigned c = src[i];
 199         dst[i] = ebc2asc[c];
 200     }
 201 }
 202
 203 #endif /* S390_CCW_H */