1 /* 2 * Console support for hndrte. 3 * 4 * Copyright (C) 1999-2010, 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,v 13.1.2.4 2010/07/15 19:06:11 Exp $ 25 */ 26 27 #include <typedefs.h> 28 29 #define CBUF_LEN (128) 30 31 #define LOG_BUF_LEN 1024 32 33 typedef struct { 34 uint32 buf; /* Can't be pointer on (64-bit) hosts */ 35 uint buf_size; 36 uint idx; 37 char *_buf_compat; /* Redundant pointer for backward compat. */ 38 } hndrte_log_t; 39 40 typedef struct { 41 /* Virtual UART 42 * When there is no UART (e.g. Quickturn), the host should write a complete 43 * input line directly into cbuf and then write the length into vcons_in. 44 * This may also be used when there is a real UART (at risk of conflicting with 45 * the real UART). vcons_out is currently unused. 46 */ 47 volatile uint vcons_in; 48 volatile uint vcons_out; 49 50 /* Output (logging) buffer 51 * Console output is written to a ring buffer log_buf at index log_idx. 52 * The host may read the output when it sees log_idx advance. 53 * Output will be lost if the output wraps around faster than the host polls. 54 */ 55 hndrte_log_t log; 56 57 /* Console input line buffer 58 * Characters are read one at a time into cbuf until <CR> is received, then 59 * the buffer is processed as a command line. Also used for virtual UART. 60 */ 61 uint cbuf_idx; 62 char cbuf[CBUF_LEN]; 63 } hndrte_cons_t; 64
