sys/dev/virtio/console/virtio_console.h

   1 /*-
   2  * This header is BSD licensed so anyone can use the definitions to implement
   3  * compatible drivers/servers.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of IBM nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * Copyright (C) Red Hat, Inc., 2009, 2010, 2011
  29  * Copyright (C) Amit Shah <amit.shah@redhat.com>, 2009, 2010, 2011
  30  *
  31  * $FreeBSD$
  32  */
  33
  34 #ifndef _VIRTIO_CONSOLE_H
  35 #define _VIRTIO_CONSOLE_H
  36
  37 /* Feature bits */
  38 #define VIRTIO_CONSOLE_F_SIZE           0x01    /* Console size */
  39 #define VIRTIO_CONSOLE_F_MULTIPORT      0x02    /* Multiple ports */
  40 #define VIRTIO_CONSOLE_F_EMERG_WRITE    0x04    /* Emergency write */
  41
  42 #define VIRTIO_CONSOLE_BAD_ID           (~(uint32_t)0)
  43
  44 struct virtio_console_config {
  45         /* colums of the screens */
  46         uint16_t cols;
  47         /* rows of the screens */
  48         uint16_t rows;
  49         /* max. number of ports this device can hold */
  50         uint32_t max_nr_ports;
  51         /* emergency write register */
  52         uint32_t emerg_wr;
  53 } __packed;
  54
  55 /*
  56  * A message that's passed between the Host and the Guest for a
  57  * particular port.
  58  */
  59 struct virtio_console_control {
  60         uint32_t id;            /* Port number */
  61         uint16_t event;         /* The kind of control event (see below) */
  62         uint16_t value;         /* Extra information for the key */
  63 };
  64
  65 /* Some events for control messages */
  66 #define VIRTIO_CONSOLE_DEVICE_READY     0
  67 #define VIRTIO_CONSOLE_PORT_ADD         1
  68 #define VIRTIO_CONSOLE_PORT_REMOVE      2
  69 #define VIRTIO_CONSOLE_PORT_READY       3
  70 #define VIRTIO_CONSOLE_CONSOLE_PORT     4
  71 #define VIRTIO_CONSOLE_RESIZE           5
  72 #define VIRTIO_CONSOLE_PORT_OPEN        6
  73 #define VIRTIO_CONSOLE_PORT_NAME        7
  74
  75 #endif /* _VIRTIO_CONSOLE_H */