xref: /freebsd/sys/powerpc/pseries/phyp_dbg.c (revision 4d846d260e2b9a3d4d0a701462568268cbfe7a5b)
14ceaf951SLeandro Lupori /*-
2*4d846d26SWarner Losh  * SPDX-License-Identifier: BSD-2-Clause
34ceaf951SLeandro Lupori  *
44ceaf951SLeandro Lupori  * Copyright (C) 2019 Leandro Lupori
54ceaf951SLeandro Lupori  *
64ceaf951SLeandro Lupori  * Redistribution and use in source and binary forms, with or without
74ceaf951SLeandro Lupori  * modification, are permitted provided that the following conditions
84ceaf951SLeandro Lupori  * are met:
94ceaf951SLeandro Lupori  * 1. Redistributions of source code must retain the above copyright
104ceaf951SLeandro Lupori  *    notice, this list of conditions and the following disclaimer.
114ceaf951SLeandro Lupori  * 2. Redistributions in binary form must reproduce the above copyright
124ceaf951SLeandro Lupori  *    notice, this list of conditions and the following disclaimer in the
134ceaf951SLeandro Lupori  *    documentation and/or other materials provided with the distribution.
144ceaf951SLeandro Lupori  *
154ceaf951SLeandro Lupori  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
164ceaf951SLeandro Lupori  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
174ceaf951SLeandro Lupori  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
184ceaf951SLeandro Lupori  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
194ceaf951SLeandro Lupori  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
204ceaf951SLeandro Lupori  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
214ceaf951SLeandro Lupori  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
224ceaf951SLeandro Lupori  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
234ceaf951SLeandro Lupori  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
244ceaf951SLeandro Lupori  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
254ceaf951SLeandro Lupori  */
264ceaf951SLeandro Lupori 
274ceaf951SLeandro Lupori #include <sys/cdefs.h>
284ceaf951SLeandro Lupori __FBSDID("$FreeBSD$");
294ceaf951SLeandro Lupori 
304ceaf951SLeandro Lupori #include <sys/linker_set.h>
314ceaf951SLeandro Lupori 
324ceaf951SLeandro Lupori #include <dev/ofw/openfirm.h>
334ceaf951SLeandro Lupori #include <gdb/gdb.h>
344ceaf951SLeandro Lupori 
354ceaf951SLeandro Lupori #include "phyp-hvcall.h"
364ceaf951SLeandro Lupori 
374ceaf951SLeandro Lupori static gdb_probe_f uart_phyp_dbg_probe;
384ceaf951SLeandro Lupori static gdb_init_f uart_phyp_dbg_init;
394ceaf951SLeandro Lupori static gdb_term_f uart_phyp_dbg_term;
404ceaf951SLeandro Lupori static gdb_getc_f uart_phyp_dbg_getc;
414ceaf951SLeandro Lupori static gdb_putc_f uart_phyp_dbg_putc;
424ceaf951SLeandro Lupori 
434ceaf951SLeandro Lupori GDB_DBGPORT(uart_phyp, uart_phyp_dbg_probe,
444ceaf951SLeandro Lupori     uart_phyp_dbg_init, uart_phyp_dbg_term,
454ceaf951SLeandro Lupori     uart_phyp_dbg_getc, uart_phyp_dbg_putc);
464ceaf951SLeandro Lupori 
474ceaf951SLeandro Lupori static struct uart_phyp_dbgport {
484ceaf951SLeandro Lupori 	cell_t vtermid;
494ceaf951SLeandro Lupori 	union {
504ceaf951SLeandro Lupori 		uint64_t u64[2];
514ceaf951SLeandro Lupori 		char str[16];
524ceaf951SLeandro Lupori 	} inbuf;
534ceaf951SLeandro Lupori 	uint64_t inbuflen;
544ceaf951SLeandro Lupori } dbgport;
554ceaf951SLeandro Lupori 
564ceaf951SLeandro Lupori static int
574ceaf951SLeandro Lupori uart_phyp_dbg_probe(void)
584ceaf951SLeandro Lupori {
594ceaf951SLeandro Lupori 	char buf[64];
604ceaf951SLeandro Lupori 	cell_t reg;
614ceaf951SLeandro Lupori 	phandle_t vty;
624ceaf951SLeandro Lupori 
63a16111e6SLeandro Lupori 	if (!getenv_string("hw.uart.dbgport", buf, sizeof(buf)))
644ceaf951SLeandro Lupori 		return (-1);
654ceaf951SLeandro Lupori 
664ceaf951SLeandro Lupori 	if ((vty = OF_finddevice(buf)) == -1)
674ceaf951SLeandro Lupori 		return (-1);
684ceaf951SLeandro Lupori 
694ceaf951SLeandro Lupori 	if (OF_getprop(vty, "name", buf, sizeof(buf)) <= 0)
704ceaf951SLeandro Lupori 		return (-1);
714ceaf951SLeandro Lupori 	if (strcmp(buf, "vty") != 0)
724ceaf951SLeandro Lupori 		return (-1);
734ceaf951SLeandro Lupori 
744ceaf951SLeandro Lupori 	if (OF_getprop(vty, "device_type", buf, sizeof(buf)) == -1)
754ceaf951SLeandro Lupori 		return (-1);
764ceaf951SLeandro Lupori 	if (strcmp(buf, "serial") != 0)
774ceaf951SLeandro Lupori 		return (-1);
784ceaf951SLeandro Lupori 
794ceaf951SLeandro Lupori 	if (OF_getprop(vty, "compatible", buf, sizeof(buf)) <= 0)
804ceaf951SLeandro Lupori 		return (-1);
814ceaf951SLeandro Lupori 	if (strcmp(buf, "hvterm1") != 0)
824ceaf951SLeandro Lupori 		return (-1);
834ceaf951SLeandro Lupori 
844ceaf951SLeandro Lupori 	reg = ~0U;
854ceaf951SLeandro Lupori 	OF_getencprop(vty, "reg", &reg, sizeof(reg));
864ceaf951SLeandro Lupori 	if (reg == ~0U)
874ceaf951SLeandro Lupori 		return (-1);
884ceaf951SLeandro Lupori 
894ceaf951SLeandro Lupori 	dbgport.vtermid = reg;
904ceaf951SLeandro Lupori 	dbgport.inbuflen = 0;
914ceaf951SLeandro Lupori 
924ceaf951SLeandro Lupori 	return (0);
934ceaf951SLeandro Lupori }
944ceaf951SLeandro Lupori 
954ceaf951SLeandro Lupori static void
964ceaf951SLeandro Lupori uart_phyp_dbg_init(void)
974ceaf951SLeandro Lupori {
984ceaf951SLeandro Lupori }
994ceaf951SLeandro Lupori 
1004ceaf951SLeandro Lupori static void
1014ceaf951SLeandro Lupori uart_phyp_dbg_term(void)
1024ceaf951SLeandro Lupori {
1034ceaf951SLeandro Lupori }
1044ceaf951SLeandro Lupori 
1054ceaf951SLeandro Lupori static int
1064ceaf951SLeandro Lupori uart_phyp_dbg_getc(void)
1074ceaf951SLeandro Lupori {
1084ceaf951SLeandro Lupori 	int c, err, next;
1094ceaf951SLeandro Lupori 
1104ceaf951SLeandro Lupori 	if (dbgport.inbuflen == 0) {
1114ceaf951SLeandro Lupori 		err = phyp_pft_hcall(H_GET_TERM_CHAR, dbgport.vtermid,
1124ceaf951SLeandro Lupori 		    0, 0, 0, &dbgport.inbuflen, &dbgport.inbuf.u64[0],
1134ceaf951SLeandro Lupori 		    &dbgport.inbuf.u64[1]);
1144ceaf951SLeandro Lupori 		if (err != H_SUCCESS)
1154ceaf951SLeandro Lupori 			return (-1);
1164ceaf951SLeandro Lupori 	}
1174ceaf951SLeandro Lupori 
1184ceaf951SLeandro Lupori 	if (dbgport.inbuflen == 0)
1194ceaf951SLeandro Lupori 		return (-1);
1204ceaf951SLeandro Lupori 
1214ceaf951SLeandro Lupori 	c = dbgport.inbuf.str[0];
1224ceaf951SLeandro Lupori 	dbgport.inbuflen--;
1234ceaf951SLeandro Lupori 
1244ceaf951SLeandro Lupori 	if (dbgport.inbuflen == 0)
1254ceaf951SLeandro Lupori 		return (c);
1264ceaf951SLeandro Lupori 
1274ceaf951SLeandro Lupori 	/*
1284ceaf951SLeandro Lupori 	 * Since version 2.11.0, QEMU became bug-compatible
1294ceaf951SLeandro Lupori 	 * with PowerVM's vty, by inserting a \0 after every \r.
1304ceaf951SLeandro Lupori 	 * Filter it here.
1314ceaf951SLeandro Lupori 	 */
1324ceaf951SLeandro Lupori 	next = 1;
1334ceaf951SLeandro Lupori 	if (c == '\r' && dbgport.inbuf.str[next] == '\0') {
1344ceaf951SLeandro Lupori 		next++;
1354ceaf951SLeandro Lupori 		dbgport.inbuflen--;
1364ceaf951SLeandro Lupori 	}
1374ceaf951SLeandro Lupori 
1384ceaf951SLeandro Lupori 	if (dbgport.inbuflen > 0)
1394ceaf951SLeandro Lupori 		memmove(&dbgport.inbuf.str[0], &dbgport.inbuf.str[next],
1404ceaf951SLeandro Lupori 		    dbgport.inbuflen);
1414ceaf951SLeandro Lupori 
1424ceaf951SLeandro Lupori 	return (c);
1434ceaf951SLeandro Lupori }
1444ceaf951SLeandro Lupori 
1454ceaf951SLeandro Lupori static void
1464ceaf951SLeandro Lupori uart_phyp_dbg_putc(int c)
1474ceaf951SLeandro Lupori {
1484ceaf951SLeandro Lupori 	int	err;
1494ceaf951SLeandro Lupori 
1504ceaf951SLeandro Lupori 	union {
1514ceaf951SLeandro Lupori 		uint64_t u64;
1524ceaf951SLeandro Lupori 		unsigned char bytes[8];
1534ceaf951SLeandro Lupori 	} cbuf;
1544ceaf951SLeandro Lupori 
1554ceaf951SLeandro Lupori 	cbuf.bytes[0] = (unsigned char)c;
1564ceaf951SLeandro Lupori 
1574ceaf951SLeandro Lupori 	do {
1584ceaf951SLeandro Lupori 		err = phyp_hcall(H_PUT_TERM_CHAR, dbgport.vtermid, 1,
1594ceaf951SLeandro Lupori 		    cbuf.u64, 0);
1604ceaf951SLeandro Lupori 		DELAY(100);
1614ceaf951SLeandro Lupori 	} while (err == H_BUSY);
1624ceaf951SLeandro Lupori }
163