xref: /openbmc/qemu/pc-bios/s390-ccw/s390-ccw.h (revision 05caa062)
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 
21 #define true 1
22 #define false 0
23 #define PAGE_SIZE 4096
24 
25 #define EIO     1
26 #define EBUSY   2
27 #define ENODEV  3
28 
29 #ifndef NULL
30 #define NULL    0
31 #endif
32 #ifndef MIN
33 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
34 #endif
35 #ifndef MIN_NON_ZERO
36 #define MIN_NON_ZERO(a, b) ((a) == 0 ? (b) : \
37                             ((b) == 0 ? (a) : (MIN(a, b))))
38 #endif
39 
40 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
41 
42 #include "cio.h"
43 #include "iplb.h"
44 
45 /* start.s */
46 void disabled_wait(void) __attribute__ ((__noreturn__));
47 void consume_sclp_int(void);
48 void consume_io_int(void);
49 
50 /* main.c */
51 void write_subsystem_identification(void);
52 void write_iplb_location(void);
53 unsigned int get_loadparm_index(void);
54 void main(void);
55 
56 /* sclp.c */
57 void sclp_print(const char *string);
58 void sclp_set_write_mask(uint32_t receive_mask, uint32_t send_mask);
59 void sclp_setup(void);
60 void sclp_get_loadparm_ascii(char *loadparm);
61 int sclp_read(char *str, size_t count);
62 
63 /* virtio.c */
64 unsigned long virtio_load_direct(unsigned long rec_list1, unsigned long rec_list2,
65                                  unsigned long subchan_id, void *load_addr);
66 bool virtio_is_supported(SubChannelId schid);
67 int virtio_blk_setup_device(SubChannelId schid);
68 int virtio_read(unsigned long sector, void *load_addr);
69 
70 /* bootmap.c */
71 void zipl_load(void);
72 
73 /* jump2ipl.c */
74 void write_reset_psw(uint64_t psw);
75 void jump_to_IPL_code(uint64_t address);
76 void jump_to_low_kernel(void);
77 
78 /* menu.c */
79 void menu_set_parms(uint8_t boot_menu_flag, uint32_t boot_menu_timeout);
80 int menu_get_zipl_boot_index(const char *menu_data);
81 bool menu_is_enabled_zipl(void);
82 int menu_get_enum_boot_index(bool *valid_entries);
83 bool menu_is_enabled_enum(void);
84 
85 #define MAX_BOOT_ENTRIES  31
86 
87 __attribute__ ((__noreturn__))
88 static inline void panic(const char *string)
89 {
90     sclp_print(string);
91     disabled_wait();
92 }
93 
94 static inline void fill_hex(char *out, unsigned char val)
95 {
96     const char hex[] = "0123456789abcdef";
97 
98     out[0] = hex[(val >> 4) & 0xf];
99     out[1] = hex[val & 0xf];
100 }
101 
102 static inline void fill_hex_val(char *out, void *ptr, unsigned size)
103 {
104     unsigned char *value = ptr;
105     unsigned int i;
106 
107     for (i = 0; i < size; i++) {
108         fill_hex(&out[i*2], value[i]);
109     }
110 }
111 
112 static inline void print_int(const char *desc, u64 addr)
113 {
114     char out[] = ": 0xffffffffffffffff\n";
115 
116     fill_hex_val(&out[4], &addr, sizeof(addr));
117 
118     sclp_print(desc);
119     sclp_print(out);
120 }
121 
122 static inline void debug_print_int(const char *desc, u64 addr)
123 {
124 #ifdef DEBUG
125     print_int(desc, addr);
126 #endif
127 }
128 
129 static inline void debug_print_addr(const char *desc, void *p)
130 {
131 #ifdef DEBUG
132     debug_print_int(desc, (unsigned int)(unsigned long)p);
133 #endif
134 }
135 
136 /***********************************************
137  *           Hypercall functions               *
138  ***********************************************/
139 
140 #define KVM_S390_VIRTIO_NOTIFY          0
141 #define KVM_S390_VIRTIO_RESET           1
142 #define KVM_S390_VIRTIO_SET_STATUS      2
143 #define KVM_S390_VIRTIO_CCW_NOTIFY      3
144 
145 #define MAX_SECTOR_SIZE 4096
146 
147 static inline void IPL_assert(bool term, const char *message)
148 {
149     if (!term) {
150         sclp_print("\n! ");
151         sclp_print(message);
152         panic(" !\n"); /* no return */
153     }
154 }
155 
156 static inline void IPL_check(bool term, const char *message)
157 {
158     if (!term) {
159         sclp_print("\n! WARNING: ");
160         sclp_print(message);
161         sclp_print(" !\n");
162     }
163 }
164 
165 extern const unsigned char ebc2asc[256];
166 static inline void ebcdic_to_ascii(const char *src,
167                                    char *dst,
168                                    unsigned int size)
169 {
170     unsigned int i;
171 
172     for (i = 0; i < size; i++) {
173         unsigned c = src[i];
174         dst[i] = ebc2asc[c];
175     }
176 }
177 
178 #endif /* S390_CCW_H */
179