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