xref: /openbmc/linux/drivers/s390/char/sclp_rw.h (revision bc5aa3a0)
1 /*
2  * interface to the SCLP-read/write driver
3  *
4  * Copyright IBM Corporation 1999, 2009
5  *
6  * Author(s): Martin Peschke <mpeschke@de.ibm.com>
7  *	      Martin Schwidefsky <schwidefsky@de.ibm.com>
8  */
9 
10 #ifndef __SCLP_RW_H__
11 #define __SCLP_RW_H__
12 
13 #include <linux/list.h>
14 
15 struct mto {
16 	u16 length;
17 	u16 type;
18 	u16 line_type_flags;
19 	u8  alarm_control;
20 	u8  _reserved[3];
21 } __attribute__((packed));
22 
23 struct go {
24 	u16 length;
25 	u16 type;
26 	u32 domid;
27 	u8  hhmmss_time[8];
28 	u8  th_time[3];
29 	u8  reserved_0;
30 	u8  dddyyyy_date[7];
31 	u8  _reserved_1;
32 	u16 general_msg_flags;
33 	u8  _reserved_2[10];
34 	u8  originating_system_name[8];
35 	u8  job_guest_name[8];
36 } __attribute__((packed));
37 
38 struct mdb_header {
39 	u16 length;
40 	u16 type;
41 	u32 tag;
42 	u32 revision_code;
43 } __attribute__((packed));
44 
45 struct mdb {
46 	struct mdb_header header;
47 	struct go go;
48 	struct mto mto;
49 } __attribute__((packed));
50 
51 struct msg_buf {
52 	struct evbuf_header header;
53 	struct mdb mdb;
54 } __attribute__((packed));
55 
56 /* The number of empty mto buffers that can be contained in a single sccb. */
57 #define NR_EMPTY_MSG_PER_SCCB ((PAGE_SIZE - sizeof(struct sclp_buffer) - \
58 			sizeof(struct sccb_header)) / sizeof(struct msg_buf))
59 
60 /*
61  * data structure for information about list of SCCBs (only for writing),
62  * will be located at the end of a SCCBs page
63  */
64 struct sclp_buffer {
65 	struct list_head list;		/* list_head for sccb_info chain */
66 	struct sclp_req request;
67 	void *sccb;
68 	struct msg_buf *current_msg;
69 	char *current_line;
70 	int current_length;
71 	int retry_count;
72 	/* output format settings */
73 	unsigned short columns;
74 	unsigned short htab;
75 	/* statistics about this buffer */
76 	unsigned int char_sum;		/* # chars in sccb */
77 	unsigned int messages;		/* # messages in sccb */
78 	/* Callback that is called after reaching final status. */
79 	void (*callback)(struct sclp_buffer *, int);
80 };
81 
82 int sclp_rw_init(void);
83 struct sclp_buffer *sclp_make_buffer(void *, unsigned short, unsigned short);
84 void *sclp_unmake_buffer(struct sclp_buffer *);
85 int sclp_buffer_space(struct sclp_buffer *);
86 int sclp_write(struct sclp_buffer *buffer, const unsigned char *, int);
87 int sclp_emit_buffer(struct sclp_buffer *,void (*)(struct sclp_buffer *,int));
88 void sclp_set_columns(struct sclp_buffer *, unsigned short);
89 void sclp_set_htab(struct sclp_buffer *, unsigned short);
90 int sclp_chars_in_buffer(struct sclp_buffer *);
91 
92 #ifdef CONFIG_SCLP_CONSOLE
93 void sclp_console_pm_event(enum sclp_pm_event sclp_pm_event);
94 #else
95 static inline void sclp_console_pm_event(enum sclp_pm_event sclp_pm_event) { }
96 #endif
97 
98 #endif	/* __SCLP_RW_H__ */
99