xref: /kvm-unit-tests/lib/s390x/sclp-console.c (revision 6c9f99df2fa51f58bd6a8b6775810b7f249bd0d7) 
1*6c9f99dfSJanosch Frank /* SPDX-License-Identifier: GPL-2.0-or-later */
27ed7df23SJanosch Frank /*
37ed7df23SJanosch Frank  * SCLP ASCII access driver
47ed7df23SJanosch Frank  *
57ed7df23SJanosch Frank  * Copyright (c) 2013 Alexander Graf <agraf@suse.de>
67ed7df23SJanosch Frank  */
77ed7df23SJanosch Frank 
87ed7df23SJanosch Frank #include <libcflat.h>
97ed7df23SJanosch Frank #include <string.h>
107ed7df23SJanosch Frank #include <asm/page.h>
1167bee4eeSJanosch Frank #include <asm/arch_def.h>
1267bee4eeSJanosch Frank #include <asm/io.h>
1304a401ddSJanosch Frank #include <asm/spinlock.h>
147ed7df23SJanosch Frank #include "sclp.h"
157ed7df23SJanosch Frank 
1667bee4eeSJanosch Frank /*
1767bee4eeSJanosch Frank  * ASCII (IBM PC 437) -> EBCDIC 037
1867bee4eeSJanosch Frank  */
1967bee4eeSJanosch Frank static uint8_t _ascebc[256] = {
2067bee4eeSJanosch Frank  /*00 NUL   SOH   STX   ETX   EOT   ENQ   ACK   BEL */
2167bee4eeSJanosch Frank      0x00, 0x01, 0x02, 0x03, 0x37, 0x2D, 0x2E, 0x2F,
2267bee4eeSJanosch Frank  /*08  BS    HT    LF    VT    FF    CR    SO    SI */
2367bee4eeSJanosch Frank  /*              ->NL                               */
2467bee4eeSJanosch Frank      0x16, 0x05, 0x15, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F,
2567bee4eeSJanosch Frank  /*10 DLE   DC1   DC2   DC3   DC4   NAK   SYN   ETB */
2667bee4eeSJanosch Frank      0x10, 0x11, 0x12, 0x13, 0x3C, 0x3D, 0x32, 0x26,
2767bee4eeSJanosch Frank  /*18 CAN    EM   SUB   ESC    FS    GS    RS    US */
2867bee4eeSJanosch Frank  /*                               ->IGS ->IRS ->IUS */
2967bee4eeSJanosch Frank      0x18, 0x19, 0x3F, 0x27, 0x22, 0x1D, 0x1E, 0x1F,
3067bee4eeSJanosch Frank  /*20  SP     !     "     #     $     %     &     ' */
3167bee4eeSJanosch Frank      0x40, 0x5A, 0x7F, 0x7B, 0x5B, 0x6C, 0x50, 0x7D,
3267bee4eeSJanosch Frank  /*28   (     )     *     +     ,     -    .      / */
3367bee4eeSJanosch Frank      0x4D, 0x5D, 0x5C, 0x4E, 0x6B, 0x60, 0x4B, 0x61,
3467bee4eeSJanosch Frank  /*30   0     1     2     3     4     5     6     7 */
3567bee4eeSJanosch Frank      0xF0, 0xF1, 0xF2, 0xF3, 0xF4, 0xF5, 0xF6, 0xF7,
3667bee4eeSJanosch Frank  /*38   8     9     :     ;     <     =     >     ? */
3767bee4eeSJanosch Frank      0xF8, 0xF9, 0x7A, 0x5E, 0x4C, 0x7E, 0x6E, 0x6F,
3867bee4eeSJanosch Frank  /*40   @     A     B     C     D     E     F     G */
3967bee4eeSJanosch Frank      0x7C, 0xC1, 0xC2, 0xC3, 0xC4, 0xC5, 0xC6, 0xC7,
4067bee4eeSJanosch Frank  /*48   H     I     J     K     L     M     N     O */
4167bee4eeSJanosch Frank      0xC8, 0xC9, 0xD1, 0xD2, 0xD3, 0xD4, 0xD5, 0xD6,
4267bee4eeSJanosch Frank  /*50   P     Q     R     S     T     U     V     W */
4367bee4eeSJanosch Frank      0xD7, 0xD8, 0xD9, 0xE2, 0xE3, 0xE4, 0xE5, 0xE6,
4467bee4eeSJanosch Frank  /*58   X     Y     Z     [     \     ]     ^     _ */
4567bee4eeSJanosch Frank      0xE7, 0xE8, 0xE9, 0xBA, 0xE0, 0xBB, 0xB0, 0x6D,
4667bee4eeSJanosch Frank  /*60   `     a     b     c     d     e     f     g */
4767bee4eeSJanosch Frank      0x79, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87,
4867bee4eeSJanosch Frank  /*68   h     i     j     k     l     m     n     o */
4967bee4eeSJanosch Frank      0x88, 0x89, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96,
5067bee4eeSJanosch Frank  /*70   p     q     r     s     t     u     v     w */
5167bee4eeSJanosch Frank      0x97, 0x98, 0x99, 0xA2, 0xA3, 0xA4, 0xA5, 0xA6,
5267bee4eeSJanosch Frank  /*78   x     y     z     {     |     }     ~    DL */
5367bee4eeSJanosch Frank      0xA7, 0xA8, 0xA9, 0xC0, 0x4F, 0xD0, 0xA1, 0x07,
5467bee4eeSJanosch Frank  /*80*/
5567bee4eeSJanosch Frank      0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
5667bee4eeSJanosch Frank  /*88*/
5767bee4eeSJanosch Frank      0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
5867bee4eeSJanosch Frank  /*90*/
5967bee4eeSJanosch Frank      0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
6067bee4eeSJanosch Frank  /*98*/
6167bee4eeSJanosch Frank      0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
6267bee4eeSJanosch Frank  /*A0*/
6367bee4eeSJanosch Frank      0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
6467bee4eeSJanosch Frank  /*A8*/
6567bee4eeSJanosch Frank      0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
6667bee4eeSJanosch Frank  /*B0*/
6767bee4eeSJanosch Frank      0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
6867bee4eeSJanosch Frank  /*B8*/
6967bee4eeSJanosch Frank      0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
7067bee4eeSJanosch Frank  /*C0*/
7167bee4eeSJanosch Frank      0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
7267bee4eeSJanosch Frank  /*C8*/
7367bee4eeSJanosch Frank      0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
7467bee4eeSJanosch Frank  /*D0*/
7567bee4eeSJanosch Frank      0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
7667bee4eeSJanosch Frank  /*D8*/
7767bee4eeSJanosch Frank      0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
7867bee4eeSJanosch Frank  /*E0        sz	*/
7967bee4eeSJanosch Frank      0x3F, 0x59, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
8067bee4eeSJanosch Frank  /*E8*/
8167bee4eeSJanosch Frank      0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
8267bee4eeSJanosch Frank  /*F0*/
8367bee4eeSJanosch Frank      0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,
8467bee4eeSJanosch Frank  /*F8*/
8567bee4eeSJanosch Frank      0x90, 0x3F, 0x3F, 0x3F, 0x3F, 0xEA, 0x3F, 0xFF
8667bee4eeSJanosch Frank };
8767bee4eeSJanosch Frank 
8804a401ddSJanosch Frank static char lm_buff[120];
8904a401ddSJanosch Frank static unsigned char lm_buff_off;
9004a401ddSJanosch Frank static struct spinlock lm_buff_lock;
9104a401ddSJanosch Frank 
9267bee4eeSJanosch Frank static void sclp_print_ascii(const char *str)
9367bee4eeSJanosch Frank {
9467bee4eeSJanosch Frank 	int len = strlen(str);
9567bee4eeSJanosch Frank 	WriteEventData *sccb = (void *)_sccb;
9667bee4eeSJanosch Frank 
9767bee4eeSJanosch Frank 	sclp_mark_busy();
9867bee4eeSJanosch Frank 	memset(sccb, 0, sizeof(*sccb));
9967bee4eeSJanosch Frank 	sccb->h.length = offsetof(WriteEventData, msg) + len;
10067bee4eeSJanosch Frank 	sccb->h.function_code = SCLP_FC_NORMAL_WRITE;
10167bee4eeSJanosch Frank 	sccb->ebh.length = sizeof(EventBufferHeader) + len;
10267bee4eeSJanosch Frank 	sccb->ebh.type = SCLP_EVENT_ASCII_CONSOLE_DATA;
10367bee4eeSJanosch Frank 	memcpy(&sccb->msg, str, len);
10467bee4eeSJanosch Frank 
10567bee4eeSJanosch Frank 	sclp_service_call(SCLP_CMD_WRITE_EVENT_DATA, sccb);
10667bee4eeSJanosch Frank }
10767bee4eeSJanosch Frank 
10804a401ddSJanosch Frank static void lm_print(const char *buff, int len)
10967bee4eeSJanosch Frank {
11067bee4eeSJanosch Frank 	unsigned char *ptr, *end, ch;
11104a401ddSJanosch Frank 	unsigned int count, offset;
11267bee4eeSJanosch Frank 	struct WriteEventData *sccb;
11367bee4eeSJanosch Frank 	struct mdb *mdb;
11467bee4eeSJanosch Frank 	struct mto *mto;
11567bee4eeSJanosch Frank 	struct go *go;
11667bee4eeSJanosch Frank 
11767bee4eeSJanosch Frank 	sclp_mark_busy();
11867bee4eeSJanosch Frank 	sccb = (struct WriteEventData *) _sccb;
11967bee4eeSJanosch Frank 	end = (unsigned char *) sccb + 4096 - 1;
12067bee4eeSJanosch Frank 	memset(sccb, 0, sizeof(*sccb));
12167bee4eeSJanosch Frank 	ptr = (unsigned char *) &sccb->msg.mdb.mto;
12267bee4eeSJanosch Frank 	offset = 0;
12367bee4eeSJanosch Frank 	do {
12467bee4eeSJanosch Frank 		for (count = sizeof(*mto); offset < len; count++) {
12504a401ddSJanosch Frank 			ch = buff[offset++];
12667bee4eeSJanosch Frank 			if (ch == 0x0a || ptr + count > end)
12767bee4eeSJanosch Frank 				break;
12867bee4eeSJanosch Frank 			ptr[count] = _ascebc[ch];
12967bee4eeSJanosch Frank 		}
13067bee4eeSJanosch Frank 		mto = (struct mto *) ptr;
13167bee4eeSJanosch Frank 		mto->length = count;
13267bee4eeSJanosch Frank 		mto->type = 4;
13367bee4eeSJanosch Frank 		mto->line_type_flags = LNTPFLGS_ENDTEXT;
13467bee4eeSJanosch Frank 		ptr += count;
13567bee4eeSJanosch Frank 	} while (offset < len && ptr + sizeof(*mto) <= end);
13667bee4eeSJanosch Frank 	len = ptr - (unsigned char *) sccb;
13767bee4eeSJanosch Frank 	sccb->h.length = len - offsetof(struct WriteEventData, h);
13867bee4eeSJanosch Frank 	sccb->h.function_code = SCLP_FC_NORMAL_WRITE;
13967bee4eeSJanosch Frank 	sccb->ebh.type = EVTYP_MSG;
14067bee4eeSJanosch Frank 	sccb->ebh.length = len - offsetof(struct WriteEventData, ebh);
14167bee4eeSJanosch Frank 	mdb = &sccb->msg.mdb;
14267bee4eeSJanosch Frank 	mdb->header.type = 1;
14367bee4eeSJanosch Frank 	mdb->header.tag = 0xD4C4C240;
14467bee4eeSJanosch Frank 	mdb->header.revision_code = 1;
14567bee4eeSJanosch Frank 	mdb->header.length = len - offsetof(struct WriteEventData, msg.mdb.header);
14667bee4eeSJanosch Frank 	go = &mdb->go;
14767bee4eeSJanosch Frank 	go->length = sizeof(*go);
14867bee4eeSJanosch Frank 	go->type = 1;
14967bee4eeSJanosch Frank 	sclp_service_call(SCLP_CMD_WRITE_EVENT_DATA, sccb);
15067bee4eeSJanosch Frank }
15167bee4eeSJanosch Frank 
15204a401ddSJanosch Frank 
15304a401ddSJanosch Frank /*
15404a401ddSJanosch Frank  * In contrast to the ascii console, linemode produces a new
15504a401ddSJanosch Frank  * line with every write of data. The report() function uses
15604a401ddSJanosch Frank  * several printf() calls to generate a line of data which
15704a401ddSJanosch Frank  * would all end up on different lines.
15804a401ddSJanosch Frank  *
15904a401ddSJanosch Frank  * Hence we buffer here until we encounter a \n or the buffer
16004a401ddSJanosch Frank  * is full. That means that linemode output can look a bit
16104a401ddSJanosch Frank  * different from ascii and that it takes a bit longer for
16204a401ddSJanosch Frank  * lines to appear.
16304a401ddSJanosch Frank  */
16404a401ddSJanosch Frank static void sclp_print_lm(const char *str)
16504a401ddSJanosch Frank {
16604a401ddSJanosch Frank 	int i;
16704a401ddSJanosch Frank 	const int len = strlen(str);
16804a401ddSJanosch Frank 
16904a401ddSJanosch Frank 	spin_lock(&lm_buff_lock);
17004a401ddSJanosch Frank 
17104a401ddSJanosch Frank 	for (i = 0; i < len; i++) {
17204a401ddSJanosch Frank 		lm_buff[lm_buff_off++] = str[i];
17304a401ddSJanosch Frank 
17404a401ddSJanosch Frank 		/* Buffer full or newline? */
17504a401ddSJanosch Frank 		if (str[i] == '\n' || lm_buff_off == (ARRAY_SIZE(lm_buff) - 1)) {
17604a401ddSJanosch Frank 			lm_print(lm_buff, lm_buff_off);
17704a401ddSJanosch Frank 			lm_buff_off = 0;
17804a401ddSJanosch Frank 		}
17904a401ddSJanosch Frank 	}
18004a401ddSJanosch Frank 	spin_unlock(&lm_buff_lock);
18104a401ddSJanosch Frank }
18204a401ddSJanosch Frank 
18367bee4eeSJanosch Frank /*
18467bee4eeSJanosch Frank  * SCLP needs to be initialized by setting a send and receive mask,
18567bee4eeSJanosch Frank  * indicating which messages the control program (we) want(s) to
18667bee4eeSJanosch Frank  * send/receive.
18767bee4eeSJanosch Frank  */
1887ed7df23SJanosch Frank static void sclp_set_write_mask(void)
1897ed7df23SJanosch Frank {
1907ed7df23SJanosch Frank 	WriteEventMask *sccb = (void *)_sccb;
1917ed7df23SJanosch Frank 
1928ead801eSJanosch Frank 	sclp_mark_busy();
19367bee4eeSJanosch Frank 	memset(_sccb, 0, sizeof(*sccb));
1947ed7df23SJanosch Frank 	sccb->h.length = sizeof(WriteEventMask);
19567bee4eeSJanosch Frank 	sccb->h.function_code = SCLP_FC_NORMAL_WRITE;
19667bee4eeSJanosch Frank 	sccb->mask_length = sizeof(sccb_mask_t);
19767bee4eeSJanosch Frank 
19867bee4eeSJanosch Frank 	/* For now we don't process sclp input. */
19967bee4eeSJanosch Frank 	sccb->cp_receive_mask = 0;
20067bee4eeSJanosch Frank 	/* We send ASCII and line mode. */
20167bee4eeSJanosch Frank 	sccb->cp_send_mask = SCLP_EVENT_MASK_MSG_ASCII | SCLP_EVENT_MASK_MSG;
2027ed7df23SJanosch Frank 
2037ed7df23SJanosch Frank 	sclp_service_call(SCLP_CMD_WRITE_EVENT_MASK, sccb);
20467bee4eeSJanosch Frank 	assert(sccb->h.response_code == SCLP_RC_NORMAL_COMPLETION);
2057ed7df23SJanosch Frank }
2067ed7df23SJanosch Frank 
2077ed7df23SJanosch Frank void sclp_console_setup(void)
2087ed7df23SJanosch Frank {
2097ed7df23SJanosch Frank 	sclp_set_write_mask();
2107ed7df23SJanosch Frank }
2117ed7df23SJanosch Frank 
2127ed7df23SJanosch Frank void sclp_print(const char *str)
2137ed7df23SJanosch Frank {
21467bee4eeSJanosch Frank 	/*
21567bee4eeSJanosch Frank 	 * z/VM advertises a vt220 console which is not functional:
21667bee4eeSJanosch Frank 	 * (response code 05F0, "not active because of the state of
21767bee4eeSJanosch Frank 	 * the machine"). Hence testing the masks would only work if
21867bee4eeSJanosch Frank 	 * we also use stsi data to distinguish z/VM.
21967bee4eeSJanosch Frank 	 *
22067bee4eeSJanosch Frank 	 * Let's rather print on all available consoles.
22167bee4eeSJanosch Frank 	 */
22267bee4eeSJanosch Frank 	if (strlen(str) > (PAGE_SIZE / 2)) {
22367bee4eeSJanosch Frank 		sclp_print_ascii("Warning: Printing is limited to 2KB of data.");
22467bee4eeSJanosch Frank 		sclp_print_lm("Warning: Printing is limited to 2KB of data.");
22567bee4eeSJanosch Frank 		return;
22667bee4eeSJanosch Frank 	}
22767bee4eeSJanosch Frank 	sclp_print_ascii(str);
22867bee4eeSJanosch Frank 	sclp_print_lm(str);
2297ed7df23SJanosch Frank }
230