release/src-rt-6.x.4708/cfe/cfe/pccons/dev_pcconsole2.c

   1 /*  *********************************************************************
   2     *  Broadcom Common Firmware Environment (CFE)
   3     *
   4     *  PC Console driver                        File: dev_pcconsole2.c
   5     *
   6     *  A console driver for a PC-style keyboard and mouse
   7     *
   8     *  This version is for USB keyboards.  Someday we'll consolidate
   9     *  everything.
  10     *
  11     *  Author:  Mitch Lichtenberg (mpl@broadcom.com)
  12     *
  13     *********************************************************************
  14     *
  15     *  Copyright 2000,2001,2002,2003
  16     *  Broadcom Corporation. All rights reserved.
  17     *
  18     *  This software is furnished under license and may be used and
  19     *  copied only in accordance with the following terms and
  20     *  conditions.  Subject to these conditions, you may download,
  21     *  copy, install, use, modify and distribute modified or unmodified
  22     *  copies of this software in source and/or binary form.  No title
  23     *  or ownership is transferred hereby.
  24     *
  25     *  1) Any source code used, modified or distributed must reproduce
  26     *     and retain this copyright notice and list of conditions
  27     *     as they appear in the source file.
  28     *
  29     *  2) No right is granted to use any trade name, trademark, or
  30     *     logo of Broadcom Corporation.  The "Broadcom Corporation"
  31     *     name may not be used to endorse or promote products derived
  32     *     from this software without the prior written permission of
  33     *     Broadcom Corporation.
  34     *
  35     *  3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR
  36     *     IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED
  37     *     WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  38     *     PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT
  39     *     SHALL BROADCOM BE LIABLE FOR ANY DAMAGES WHATSOEVER, AND IN
  40     *     PARTICULAR, BROADCOM SHALL NOT BE LIABLE FOR DIRECT, INDIRECT,
  41     *     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  42     *     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  43     *     GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  44     *     BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  45     *     OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  46     *     TORT (INCLUDING NEGLIGENCE OR OTHERWISE), EVEN IF ADVISED OF
  47     *     THE POSSIBILITY OF SUCH DAMAGE.
  48     ********************************************************************* */
  49
  50
  51
  52
  53 #include "sbmips.h"
  54 #include "lib_types.h"
  55 #include "lib_malloc.h"
  56 #include "lib_printf.h"
  57 #include "lib_string.h"
  58
  59 #include "cfe_iocb.h"
  60 #include "cfe_device.h"
  61 #include "cfe_timer.h"
  62
  63 #include "lib_physio.h"
  64
  65 #include "vga_subr.h"
  66
  67 #include "bsp_config.h"
  68 #include "pcireg.h"
  69 #include "pcivar.h"
  70
  71 /*  *********************************************************************
  72     *  Constants
  73     ********************************************************************* */
  74
  75 #define KBD_RXFULL              1               /* bit set if kb has data */
  76 #define KBD_TXFULL              2               /* bit set if we can send cmd */
  77 #define VGA_TEXTBUF_COLOR       0xB8000         /* VGA frame buffer */
  78
  79 #define __ISAaddr(x)(0x40000000+(x))
  80
  81 /*  *********************************************************************
  82     *  Forward references
  83     ********************************************************************* */
  84
  85 int pcconsole_enqueue(uint8_t ch);
  86
  87 static void pcconsole_probe(cfe_driver_t *drv,
  88                               unsigned long probe_a, unsigned long probe_b,
  89                               void *probe_ptr);
  90
  91
  92 static int pcconsole_open(cfe_devctx_t *ctx);
  93 static int pcconsole_read(cfe_devctx_t *ctx,iocb_buffer_t *buffer);
  94 static int pcconsole_inpstat(cfe_devctx_t *ctx,iocb_inpstat_t *inpstat);
  95 static int pcconsole_write(cfe_devctx_t *ctx,iocb_buffer_t *buffer);
  96 static int pcconsole_ioctl(cfe_devctx_t *ctx,iocb_buffer_t *buffer);
  97 static int pcconsole_close(cfe_devctx_t *ctx);
  98 static void pcconsole_poll(cfe_devctx_t *ctx,int64_t ticks);
  99
 100 const static cfe_devdisp_t pcconsole_dispatch = {
 101     pcconsole_open,
 102     pcconsole_read,
 103     pcconsole_inpstat,
 104     pcconsole_write,
 105     pcconsole_ioctl,
 106     pcconsole_close,
 107     pcconsole_poll,
 108     NULL
 109 };
 110
 111 const cfe_driver_t pcconsole2 = {
 112     "PC Console (USB)",
 113     "pcconsole",
 114     CFE_DEV_SERIAL,
 115     &pcconsole_dispatch,
 116     pcconsole_probe
 117 };
 118
 119
 120 /*  *********************************************************************
 121     *  Structures
 122     ********************************************************************* */
 123
 124 #define KBD_QUEUE_LEN   32
 125
 126 typedef struct pcconsole_s {
 127     vga_term_t vga;
 128     int kbd_in;
 129     int kbd_out;
 130     uint8_t kbd_data[KBD_QUEUE_LEN];
 131 } pcconsole_t;
 132
 133 static pcconsole_t *pcconsole_current = NULL;
 134
 135 /*  *********************************************************************
 136     *  pcconsole_poll(ctx,ticks)
 137     *
 138     *  Poll routine - check for new keyboard events
 139     *
 140     *  Input parameters:
 141     *      ctx - device context
 142     *      ticks - current time
 143     *
 144     *  Return value:
 145     *      nothing
 146     ********************************************************************* */
 147
 148
 149 static void pcconsole_poll(cfe_devctx_t *ctx,int64_t ticks)
 150 {
 151     /* No polling needed, USB will do the work for us */
 152 }
 153
 154
 155
 156 /*  *********************************************************************
 157     *  pcconsole_probe(drv,probe_a,probe_b,probe_ptr)
 158     *
 159     *  Probe routine.  This routine sets up the pcconsole device
 160     *
 161     *  Input parameters:
 162     *      drv - driver structure
 163     *      probe_a
 164     *      probe_b
 165     *      probe_ptr
 166     *
 167     *  Return value:
 168     *      nothing
 169     ********************************************************************* */
 170
 171 static void pcconsole_probe(cfe_driver_t *drv,
 172                               unsigned long probe_a, unsigned long probe_b,
 173                               void *probe_ptr)
 174 {
 175     pcconsole_t *softc;
 176     char descr[80];
 177
 178     /*
 179      * probe_a is
 180      * probe_b is
 181      * probe_ptr is
 182      */
 183
 184     softc = (pcconsole_t *) KMALLOC(sizeof(pcconsole_t),0);
 185     if (softc) {
 186
 187         memset(softc,0,sizeof(pcconsole_t));
 188
 189         vga_init(&(softc->vga),__ISAaddr(VGA_TEXTBUF_COLOR),outb);
 190
 191         xsprintf(descr,"%s",drv->drv_description,probe_a,probe_b);
 192         cfe_attach(drv,softc,NULL,descr);
 193         }
 194
 195 }
 196
 197
 198 static int pcconsole_open(cfe_devctx_t *ctx)
 199 {
 200     pcconsole_t *softc = ctx->dev_softc;
 201
 202     pcconsole_current = softc;
 203
 204     softc->kbd_in = 0;
 205     softc->kbd_out = 0;
 206
 207     vga_clear(&(softc->vga));
 208     vga_setcursor(&(softc->vga),0,0);
 209
 210     return 0;
 211 }
 212
 213 static int pcconsole_read(cfe_devctx_t *ctx,iocb_buffer_t *buffer)
 214 {
 215     pcconsole_t *softc = ctx->dev_softc;
 216     unsigned char *bptr;
 217     int blen;
 218
 219     bptr = buffer->buf_ptr;
 220     blen = buffer->buf_length;
 221
 222     while ((blen > 0) && (softc->kbd_in != softc->kbd_out)) {
 223         *bptr++ = softc->kbd_data[softc->kbd_out];
 224         softc->kbd_out++;
 225         if (softc->kbd_out >= KBD_QUEUE_LEN) {
 226             softc->kbd_out = 0;
 227             }
 228         blen--;
 229         }
 230
 231     buffer->buf_retlen = buffer->buf_length - blen;
 232     return 0;
 233 }
 234
 235 static int pcconsole_inpstat(cfe_devctx_t *ctx,iocb_inpstat_t *inpstat)
 236 {
 237     pcconsole_t *softc = ctx->dev_softc;
 238
 239     POLL();
 240
 241     inpstat->inp_status = (softc->kbd_in != softc->kbd_out);
 242
 243     return 0;
 244 }
 245
 246 static int pcconsole_write(cfe_devctx_t *ctx,iocb_buffer_t *buffer)
 247 {
 248     pcconsole_t *softc = ctx->dev_softc;
 249     unsigned char *bptr;
 250     int blen;
 251
 252     bptr = buffer->buf_ptr;
 253     blen = buffer->buf_length;
 254
 255     vga_writestr(&(softc->vga),bptr,7,blen);
 256
 257     buffer->buf_retlen = buffer->buf_length;
 258     return 0;
 259 }
 260
 261 static int pcconsole_ioctl(cfe_devctx_t *ctx,iocb_buffer_t *buffer)
 262 {
 263 /*    pcconsole_t *softc = ctx->dev_softc;*/
 264
 265     return -1;
 266 }
 267
 268 static int pcconsole_close(cfe_devctx_t *ctx)
 269 {
 270 /*    pcconsole_t *softc = ctx->dev_softc;*/
 271     pcconsole_current = NULL;
 272
 273     return 0;
 274 }
 275
 276 /*
 277  * Called by USB system to queue characters.
 278  */
 279 int pcconsole_enqueue(uint8_t ch)
 280 {
 281     int newidx;
 282
 283     if (!pcconsole_current) return -1;
 284
 285     newidx = pcconsole_current->kbd_in+1;
 286     if (newidx >= KBD_QUEUE_LEN) newidx = 0;
 287
 288     if (newidx == pcconsole_current->kbd_out) return -1;
 289
 290     pcconsole_current->kbd_data[pcconsole_current->kbd_in] = ch;
 291     pcconsole_current->kbd_in = newidx;
 292
 293     return 0;
 294 }