drivers/net/wireless/bcmdhd/src/include/hndrte_cons.h

   1 /*
   2  * Console support for hndrte.
   3  *
   4  * Copyright (C) 1999-2011, Broadcom Corporation
   5  *
   6  *      Unless you and Broadcom execute a separate written software license
   7  * agreement governing use of this software, this software is licensed to you
   8  * under the terms of the GNU General Public License version 2 (the "GPL"),
   9  * available at http://www.broadcom.com/licenses/GPLv2.php, with the
  10  * following added to such license:
  11  *
  12  *      As a special exception, the copyright holders of this software give you
  13  * permission to link this software with independent modules, and to copy and
  14  * distribute the resulting executable under terms of your choice, provided that
  15  * you also meet, for each linked independent module, the terms and conditions of
  16  * the license of that module.  An independent module is a module which is not
  17  * derived from this software.  The special exception does not apply to any
  18  * modifications of the software.
  19  *
  20  *      Notwithstanding the above, under no circumstances may you combine this
  21  * software in any way with any other Broadcom software provided under a license
  22  * other than the GPL, without Broadcom's express prior written consent.
  23  *
  24  * $Id: hndrte_cons.h 300516 2011-12-04 17:39:44Z $
  25  */
  26 #ifndef _HNDRTE_CONS_H
  27 #define _HNDRTE_CONS_H
  28
  29 #include <typedefs.h>
  30
  31 #define CBUF_LEN        (128)
  32
  33 #define LOG_BUF_LEN     1024
  34
  35 typedef struct {
  36         uint32          buf;            /* Can't be pointer on (64-bit) hosts */
  37         uint            buf_size;
  38         uint            idx;
  39         char            *_buf_compat;   /* redundant pointer for backward compat. */
  40 } hndrte_log_t;
  41
  42 typedef struct {
  43         /* Virtual UART
  44          *   When there is no UART (e.g. Quickturn), the host should write a complete
  45          *   input line directly into cbuf and then write the length into vcons_in.
  46          *   This may also be used when there is a real UART (at risk of conflicting with
  47          *   the real UART).  vcons_out is currently unused.
  48          */
  49         volatile uint   vcons_in;
  50         volatile uint   vcons_out;
  51
  52         /* Output (logging) buffer
  53          *   Console output is written to a ring buffer log_buf at index log_idx.
  54          *   The host may read the output when it sees log_idx advance.
  55          *   Output will be lost if the output wraps around faster than the host polls.
  56          */
  57         hndrte_log_t    log;
  58
  59         /* Console input line buffer
  60          *   Characters are read one at a time into cbuf until <CR> is received, then
  61          *   the buffer is processed as a command line.  Also used for virtual UART.
  62          */
  63         uint            cbuf_idx;
  64         char            cbuf[CBUF_LEN];
  65 } hndrte_cons_t;
  66
  67 #endif /* _HNDRTE_CONS_H */