blob: 8f4d9fe472239097cff483caee13afede2db2b07 [file] [log] [blame]
Peter Maydell0d755902016-01-26 18:16:58 +00001#include "qemu/osdep.h"
Thomas Huth7bacfd72016-11-10 21:16:01 +01002#include "qemu/error-report.h"
Markus Armbruster0b8fa322019-05-23 16:35:07 +02003#include "qemu/module.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +01004#include "qapi/error.h"
Paolo Bonzini4771d752016-01-19 21:51:44 +01005#include "cpu.h"
Markus Armbrusterd6454272019-08-12 07:23:45 +02006#include "migration/vmstate.h"
Marc-André Lureau4d43a602017-01-26 18:26:44 +04007#include "chardev/char-fe.h"
Paolo Bonzini0d09e412013-02-05 17:06:20 +01008#include "hw/ppc/spapr.h"
9#include "hw/ppc/spapr_vio.h"
Markus Armbrustera27bd6c2019-08-12 07:23:51 +020010#include "hw/qdev-properties.h"
David Gibson4040ab72011-04-01 15:15:21 +110011
12#define VTERM_BUFSIZE 16
13
David Gibsonce2918c2019-03-06 15:35:37 +110014typedef struct SpaprVioVty {
15 SpaprVioDevice sdev;
Marc-André Lureaubecdfa02016-10-22 12:52:51 +030016 CharBackend chardev;
David Gibson4040ab72011-04-01 15:15:21 +110017 uint32_t in, out;
18 uint8_t buf[VTERM_BUFSIZE];
David Gibsonce2918c2019-03-06 15:35:37 +110019} SpaprVioVty;
David Gibson4040ab72011-04-01 15:15:21 +110020
David Gibsonfd506b4f2013-04-07 19:08:16 +000021#define TYPE_VIO_SPAPR_VTY_DEVICE "spapr-vty"
22#define VIO_SPAPR_VTY_DEVICE(obj) \
David Gibsonce2918c2019-03-06 15:35:37 +110023 OBJECT_CHECK(SpaprVioVty, (obj), TYPE_VIO_SPAPR_VTY_DEVICE)
David Gibsonfd506b4f2013-04-07 19:08:16 +000024
David Gibson4040ab72011-04-01 15:15:21 +110025static int vty_can_receive(void *opaque)
26{
David Gibsonce2918c2019-03-06 15:35:37 +110027 SpaprVioVty *dev = VIO_SPAPR_VTY_DEVICE(opaque);
David Gibson4040ab72011-04-01 15:15:21 +110028
Thomas Huth8a273cb2016-11-18 10:09:37 +010029 return VTERM_BUFSIZE - (dev->in - dev->out);
David Gibson4040ab72011-04-01 15:15:21 +110030}
31
32static void vty_receive(void *opaque, const uint8_t *buf, int size)
33{
David Gibsonce2918c2019-03-06 15:35:37 +110034 SpaprVioVty *dev = VIO_SPAPR_VTY_DEVICE(opaque);
David Gibson4040ab72011-04-01 15:15:21 +110035 int i;
36
David Gibson0201e2d2011-04-01 15:15:27 +110037 if ((dev->in == dev->out) && size) {
38 /* toggle line to simulate edge interrupt */
David Gibson7678b742019-09-23 15:50:09 +100039 spapr_vio_irq_pulse(&dev->sdev);
David Gibson0201e2d2011-04-01 15:15:27 +110040 }
David Gibson4040ab72011-04-01 15:15:21 +110041 for (i = 0; i < size; i++) {
Thomas Huth7bacfd72016-11-10 21:16:01 +010042 if (dev->in - dev->out >= VTERM_BUFSIZE) {
43 static bool reported;
44 if (!reported) {
45 error_report("VTY input buffer exhausted - characters dropped."
46 " (input size = %i)", size);
47 reported = true;
48 }
49 break;
50 }
David Gibson4040ab72011-04-01 15:15:21 +110051 dev->buf[dev->in++ % VTERM_BUFSIZE] = buf[i];
52 }
53}
54
David Gibsonce2918c2019-03-06 15:35:37 +110055static int vty_getchars(SpaprVioDevice *sdev, uint8_t *buf, int max)
David Gibson4040ab72011-04-01 15:15:21 +110056{
David Gibsonce2918c2019-03-06 15:35:37 +110057 SpaprVioVty *dev = VIO_SPAPR_VTY_DEVICE(sdev);
David Gibson4040ab72011-04-01 15:15:21 +110058 int n = 0;
59
60 while ((n < max) && (dev->out != dev->in)) {
Paul Mackerrasfd38b162019-07-31 14:36:54 +100061 /*
62 * Long ago, PowerVM's vty implementation had a bug where it
63 * inserted a \0 after every \r going to the guest. Existing
64 * guests have a workaround for this which removes every \0
65 * immediately following a \r. To avoid triggering this
66 * workaround, we stop before inserting a \0 if the preceding
67 * character in the output buffer is a \r.
68 */
69 if (n > 0 && (buf[n - 1] == '\r') &&
70 (dev->buf[dev->out % VTERM_BUFSIZE] == '\0')) {
71 break;
David Gibson6c3bc242017-11-20 17:49:25 +110072 }
Paul Mackerrasfd38b162019-07-31 14:36:54 +100073 buf[n++] = dev->buf[dev->out++ % VTERM_BUFSIZE];
David Gibson4040ab72011-04-01 15:15:21 +110074 }
75
Marc-André Lureau5345fdb2016-10-22 12:52:55 +030076 qemu_chr_fe_accept_input(&dev->chardev);
Anton Blanchard7770b6f2013-08-13 14:10:04 +100077
David Gibson4040ab72011-04-01 15:15:21 +110078 return n;
79}
80
David Gibsonce2918c2019-03-06 15:35:37 +110081void vty_putchars(SpaprVioDevice *sdev, uint8_t *buf, int len)
David Gibson4040ab72011-04-01 15:15:21 +110082{
David Gibsonce2918c2019-03-06 15:35:37 +110083 SpaprVioVty *dev = VIO_SPAPR_VTY_DEVICE(sdev);
David Gibson4040ab72011-04-01 15:15:21 +110084
Daniel P. Berrange6ab3fc32016-09-06 14:56:04 +010085 /* XXX this blocks entire thread. Rewrite to use
86 * qemu_chr_fe_write and background I/O callbacks */
Marc-André Lureau5345fdb2016-10-22 12:52:55 +030087 qemu_chr_fe_write_all(&dev->chardev, buf, len);
David Gibson4040ab72011-04-01 15:15:21 +110088}
89
David Gibsonce2918c2019-03-06 15:35:37 +110090static void spapr_vty_realize(SpaprVioDevice *sdev, Error **errp)
David Gibson4040ab72011-04-01 15:15:21 +110091{
David Gibsonce2918c2019-03-06 15:35:37 +110092 SpaprVioVty *dev = VIO_SPAPR_VTY_DEVICE(sdev);
David Gibson4040ab72011-04-01 15:15:21 +110093
Anton Nefedov30650702017-07-06 15:08:52 +030094 if (!qemu_chr_fe_backend_connected(&dev->chardev)) {
Markus Armbruster28b07e72015-02-27 11:52:17 +010095 error_setg(errp, "chardev property not set");
96 return;
Michael Ellerman57285302011-11-13 17:18:59 +000097 }
98
Marc-André Lureau5345fdb2016-10-22 12:52:55 +030099 qemu_chr_fe_set_handlers(&dev->chardev, vty_can_receive,
Anton Nefedov81517ba2017-07-06 15:08:49 +0300100 vty_receive, NULL, NULL, dev, NULL, true);
David Gibson4040ab72011-04-01 15:15:21 +1100101}
102
David Gibson3feef8a2011-11-13 17:19:01 +0000103/* Forward declaration */
David Gibsonce2918c2019-03-06 15:35:37 +1100104static target_ulong h_put_term_char(PowerPCCPU *cpu, SpaprMachineState *spapr,
David Gibson4040ab72011-04-01 15:15:21 +1100105 target_ulong opcode, target_ulong *args)
106{
107 target_ulong reg = args[0];
108 target_ulong len = args[1];
109 target_ulong char0_7 = args[2];
110 target_ulong char8_15 = args[3];
David Gibsonce2918c2019-03-06 15:35:37 +1100111 SpaprVioDevice *sdev;
David Gibson4040ab72011-04-01 15:15:21 +1100112 uint8_t buf[16];
113
David Gibson3feef8a2011-11-13 17:19:01 +0000114 sdev = vty_lookup(spapr, reg);
David Gibson4040ab72011-04-01 15:15:21 +1100115 if (!sdev) {
116 return H_PARAMETER;
117 }
118
119 if (len > 16) {
120 return H_PARAMETER;
121 }
122
123 *((uint64_t *)buf) = cpu_to_be64(char0_7);
124 *((uint64_t *)buf + 1) = cpu_to_be64(char8_15);
125
126 vty_putchars(sdev, buf, len);
127
128 return H_SUCCESS;
129}
130
David Gibsonce2918c2019-03-06 15:35:37 +1100131static target_ulong h_get_term_char(PowerPCCPU *cpu, SpaprMachineState *spapr,
David Gibson4040ab72011-04-01 15:15:21 +1100132 target_ulong opcode, target_ulong *args)
133{
134 target_ulong reg = args[0];
135 target_ulong *len = args + 0;
136 target_ulong *char0_7 = args + 1;
137 target_ulong *char8_15 = args + 2;
David Gibsonce2918c2019-03-06 15:35:37 +1100138 SpaprVioDevice *sdev;
David Gibson4040ab72011-04-01 15:15:21 +1100139 uint8_t buf[16];
140
David Gibson3feef8a2011-11-13 17:19:01 +0000141 sdev = vty_lookup(spapr, reg);
David Gibson4040ab72011-04-01 15:15:21 +1100142 if (!sdev) {
143 return H_PARAMETER;
144 }
145
146 *len = vty_getchars(sdev, buf, sizeof(buf));
147 if (*len < 16) {
148 memset(buf + *len, 0, 16 - *len);
149 }
150
151 *char0_7 = be64_to_cpu(*((uint64_t *)buf));
152 *char8_15 = be64_to_cpu(*((uint64_t *)buf + 1));
153
154 return H_SUCCESS;
155}
156
David Gibsonce2918c2019-03-06 15:35:37 +1100157void spapr_vty_create(SpaprVioBus *bus, Chardev *chardev)
David Gibson4040ab72011-04-01 15:15:21 +1100158{
159 DeviceState *dev;
160
161 dev = qdev_create(&bus->bus, "spapr-vty");
David Gibson4040ab72011-04-01 15:15:21 +1100162 qdev_prop_set_chr(dev, "chardev", chardev);
163 qdev_init_nofail(dev);
David Gibson4040ab72011-04-01 15:15:21 +1100164}
165
Anthony Liguori3954d332011-12-15 16:31:06 -0600166static Property spapr_vty_properties[] = {
David Gibsonce2918c2019-03-06 15:35:37 +1100167 DEFINE_SPAPR_PROPERTIES(SpaprVioVty, sdev),
168 DEFINE_PROP_CHR("chardev", SpaprVioVty, chardev),
Anthony Liguori3954d332011-12-15 16:31:06 -0600169 DEFINE_PROP_END_OF_LIST(),
170};
171
David Gibsondb1b58e2013-07-18 14:32:57 -0500172static const VMStateDescription vmstate_spapr_vty = {
173 .name = "spapr_vty",
174 .version_id = 1,
175 .minimum_version_id = 1,
Juan Quintela3aff6c22014-04-16 15:24:04 +0200176 .fields = (VMStateField[]) {
David Gibsonce2918c2019-03-06 15:35:37 +1100177 VMSTATE_SPAPR_VIO(sdev, SpaprVioVty),
David Gibsondb1b58e2013-07-18 14:32:57 -0500178
David Gibsonce2918c2019-03-06 15:35:37 +1100179 VMSTATE_UINT32(in, SpaprVioVty),
180 VMSTATE_UINT32(out, SpaprVioVty),
181 VMSTATE_BUFFER(buf, SpaprVioVty),
David Gibsondb1b58e2013-07-18 14:32:57 -0500182 VMSTATE_END_OF_LIST()
183 },
184};
185
Anthony Liguori3954d332011-12-15 16:31:06 -0600186static void spapr_vty_class_init(ObjectClass *klass, void *data)
187{
Anthony Liguori39bffca2011-12-07 21:34:16 -0600188 DeviceClass *dc = DEVICE_CLASS(klass);
David Gibsonce2918c2019-03-06 15:35:37 +1100189 SpaprVioDeviceClass *k = VIO_SPAPR_DEVICE_CLASS(klass);
Anthony Liguori3954d332011-12-15 16:31:06 -0600190
Markus Armbruster28b07e72015-02-27 11:52:17 +0100191 k->realize = spapr_vty_realize;
Anthony Liguori3954d332011-12-15 16:31:06 -0600192 k->dt_name = "vty";
193 k->dt_type = "serial";
194 k->dt_compatible = "hvterm1";
Alexey Kardashevskiy29fdedf2013-10-11 14:08:20 +1100195 set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
Anthony Liguori39bffca2011-12-07 21:34:16 -0600196 dc->props = spapr_vty_properties;
David Gibsondb1b58e2013-07-18 14:32:57 -0500197 dc->vmsd = &vmstate_spapr_vty;
Anthony Liguori3954d332011-12-15 16:31:06 -0600198}
199
Andreas Färber8c43a6f2013-01-10 16:19:07 +0100200static const TypeInfo spapr_vty_info = {
David Gibsonfd506b4f2013-04-07 19:08:16 +0000201 .name = TYPE_VIO_SPAPR_VTY_DEVICE,
Anthony Liguori39bffca2011-12-07 21:34:16 -0600202 .parent = TYPE_VIO_SPAPR_DEVICE,
David Gibsonce2918c2019-03-06 15:35:37 +1100203 .instance_size = sizeof(SpaprVioVty),
Anthony Liguori39bffca2011-12-07 21:34:16 -0600204 .class_init = spapr_vty_class_init,
David Gibson4040ab72011-04-01 15:15:21 +1100205};
206
David Gibsonce2918c2019-03-06 15:35:37 +1100207SpaprVioDevice *spapr_vty_get_default(SpaprVioBus *bus)
David Gibson98331f82011-12-12 18:24:33 +0000208{
David Gibsonce2918c2019-03-06 15:35:37 +1100209 SpaprVioDevice *sdev, *selected;
Anthony Liguori0866aca2011-12-23 15:34:39 -0600210 BusChild *kid;
David Gibson98331f82011-12-12 18:24:33 +0000211
212 /*
213 * To avoid the console bouncing around we want one VTY to be
214 * the "default". We haven't really got anything to go on, so
215 * arbitrarily choose the one with the lowest reg value.
216 */
217
218 selected = NULL;
Anthony Liguori0866aca2011-12-23 15:34:39 -0600219 QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
220 DeviceState *iter = kid->child;
221
David Gibson98331f82011-12-12 18:24:33 +0000222 /* Only look at VTY devices */
David Gibsone2759342015-07-02 16:23:25 +1000223 if (!object_dynamic_cast(OBJECT(iter), TYPE_VIO_SPAPR_VTY_DEVICE)) {
David Gibson98331f82011-12-12 18:24:33 +0000224 continue;
225 }
226
David Gibsonfd506b4f2013-04-07 19:08:16 +0000227 sdev = VIO_SPAPR_DEVICE(iter);
David Gibson98331f82011-12-12 18:24:33 +0000228
229 /* First VTY we've found, so it is selected for now */
230 if (!selected) {
231 selected = sdev;
232 continue;
233 }
234
235 /* Choose VTY with lowest reg value */
236 if (sdev->reg < selected->reg) {
237 selected = sdev;
238 }
239 }
240
241 return selected;
242}
243
David Gibsonce2918c2019-03-06 15:35:37 +1100244SpaprVioDevice *vty_lookup(SpaprMachineState *spapr, target_ulong reg)
David Gibson3feef8a2011-11-13 17:19:01 +0000245{
David Gibsonce2918c2019-03-06 15:35:37 +1100246 SpaprVioDevice *sdev;
David Gibson3feef8a2011-11-13 17:19:01 +0000247
248 sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
249 if (!sdev && reg == 0) {
David Gibson3feef8a2011-11-13 17:19:01 +0000250 /* Hack for kernel early debug, which always specifies reg==0.
David Gibson98331f82011-12-12 18:24:33 +0000251 * We search all VIO devices, and grab the vty with the lowest
252 * reg. This attempts to mimic existing PowerVM behaviour
David Gibson3feef8a2011-11-13 17:19:01 +0000253 * (early debug does work there, despite having no vty with
254 * reg==0. */
David Gibson98331f82011-12-12 18:24:33 +0000255 return spapr_vty_get_default(spapr->vio_bus);
David Gibson3feef8a2011-11-13 17:19:01 +0000256 }
257
David Gibson0f888bf2015-07-02 16:23:24 +1000258 if (!object_dynamic_cast(OBJECT(sdev), TYPE_VIO_SPAPR_VTY_DEVICE)) {
259 return NULL;
260 }
261
David Gibson3feef8a2011-11-13 17:19:01 +0000262 return sdev;
263}
264
Andreas Färber83f7d432012-02-09 15:20:55 +0100265static void spapr_vty_register_types(void)
David Gibson4040ab72011-04-01 15:15:21 +1100266{
David Gibson1fc02532011-12-12 18:24:28 +0000267 spapr_register_hypercall(H_PUT_TERM_CHAR, h_put_term_char);
268 spapr_register_hypercall(H_GET_TERM_CHAR, h_get_term_char);
Anthony Liguori39bffca2011-12-07 21:34:16 -0600269 type_register_static(&spapr_vty_info);
David Gibson4040ab72011-04-01 15:15:21 +1100270}
Andreas Färber83f7d432012-02-09 15:20:55 +0100271
272type_init(spapr_vty_register_types)