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