xref: /openbmc/qemu/pc-bios/s390-ccw/s390-ccw.h (revision 8e5739ce4b0b04d7121cb2b29521acde2a8f3a24)
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 
34 #ifndef MIN
35 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
36 #endif
37 #ifndef MIN_NON_ZERO
38 #define MIN_NON_ZERO(a, b) ((a) == 0 ? (b) : \
39                             ((b) == 0 ? (a) : (MIN(a, b))))
40 #endif
41 
42 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
43 
44 #include "cio.h"
45 #include "iplb.h"
46 
47 /* start.s */
48 void disabled_wait(void) __attribute__ ((__noreturn__));
49 void consume_sclp_int(void);
50 void consume_io_int(void);
51 
52 /* main.c */
53 void write_subsystem_identification(void);
54 void write_iplb_location(void);
55 unsigned int get_loadparm_index(void);
56 void main(void);
57 
58 /* netmain.c */
59 void netmain(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(unsigned long rec_list1, unsigned long rec_list2,
70                                  unsigned long subchan_id, void *load_addr);
71 bool virtio_is_supported(SubChannelId schid);
72 int virtio_blk_setup_device(SubChannelId schid);
73 int virtio_read(unsigned long 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 __attribute__ ((__noreturn__))
93 static inline void panic(const char *string)
94 {
95     printf("ERROR: %s\n ", string);
96     disabled_wait();
97 }
98 
99 static inline void fill_hex(char *out, unsigned char val)
100 {
101     const char hex[] = "0123456789abcdef";
102 
103     out[0] = hex[(val >> 4) & 0xf];
104     out[1] = hex[val & 0xf];
105 }
106 
107 static inline void fill_hex_val(char *out, void *ptr, unsigned size)
108 {
109     unsigned char *value = ptr;
110     unsigned int i;
111 
112     for (i = 0; i < size; i++) {
113         fill_hex(&out[i*2], value[i]);
114     }
115 }
116 
117 static inline void debug_print_int(const char *desc, u64 addr)
118 {
119 #ifdef DEBUG
120     printf("%s 0x%X\n", desc, addr);
121 #endif
122 }
123 
124 static inline void debug_print_addr(const char *desc, void *p)
125 {
126 #ifdef DEBUG
127     debug_print_int(desc, (unsigned int)(unsigned long)p);
128 #endif
129 }
130 
131 /***********************************************
132  *           Hypercall functions               *
133  ***********************************************/
134 
135 #define KVM_S390_VIRTIO_NOTIFY          0
136 #define KVM_S390_VIRTIO_RESET           1
137 #define KVM_S390_VIRTIO_SET_STATUS      2
138 #define KVM_S390_VIRTIO_CCW_NOTIFY      3
139 
140 #define MAX_SECTOR_SIZE 4096
141 
142 static inline void IPL_assert(bool term, const char *message)
143 {
144     if (!term) {
145         panic(message); /* no return */
146     }
147 }
148 
149 static inline void IPL_check(bool term, const char *message)
150 {
151     if (!term) {
152         printf("WARNING: %s\n", message);
153     }
154 }
155 
156 extern const unsigned char ebc2asc[256];
157 static inline void ebcdic_to_ascii(const char *src,
158                                    char *dst,
159                                    unsigned int size)
160 {
161     unsigned int i;
162 
163     for (i = 0; i < size; i++) {
164         unsigned c = src[i];
165         dst[i] = ebc2asc[c];
166     }
167 }
168 
169 #endif /* S390_CCW_H */
170