| /* |
| * Console support for hndrte. |
| * |
| * Copyright (C) 1999-2016, Broadcom Corporation |
| * |
| * Unless you and Broadcom execute a separate written software license |
| * agreement governing use of this software, this software is licensed to you |
| * under the terms of the GNU General Public License version 2 (the "GPL"), |
| * available at http://www.broadcom.com/licenses/GPLv2.php, with the |
| * following added to such license: |
| * |
| * As a special exception, the copyright holders of this software give you |
| * permission to link this software with independent modules, and to copy and |
| * distribute the resulting executable under terms of your choice, provided that |
| * you also meet, for each linked independent module, the terms and conditions of |
| * the license of that module. An independent module is a module which is not |
| * derived from this software. The special exception does not apply to any |
| * modifications of the software. |
| * |
| * Notwithstanding the above, under no circumstances may you combine this |
| * software in any way with any other Broadcom software provided under a license |
| * other than the GPL, without Broadcom's express prior written consent. |
| * |
| * $Id: hndrte_cons.h 427140 2013-10-02 18:07:07Z $ |
| */ |
| #ifndef _HNDRTE_CONS_H |
| #define _HNDRTE_CONS_H |
| |
| #include <typedefs.h> |
| |
| #if defined(RWL_DONGLE) || defined(UART_REFLECTOR) |
| /* For Dongle uart tranport max cmd len is 256 bytes + header length (16 bytes) |
| * In case of ASD commands we are not sure about how much is the command size |
| * To be on the safe side, input buf len CBUF_LEN is increased to max (512) bytes. |
| */ |
| #define RWL_MAX_DATA_LEN (512 + 8) /* allow some extra bytes for '/n' termination */ |
| #define CBUF_LEN (RWL_MAX_DATA_LEN + 64) /* allow 64 bytes for header ("rwl...") */ |
| #else |
| #define CBUF_LEN (128) |
| #endif /* RWL_DONGLE || UART_REFLECTOR */ |
| |
| #define LOG_BUF_LEN 1024 |
| |
| typedef struct { |
| uint32 buf; /* Can't be pointer on (64-bit) hosts */ |
| uint buf_size; |
| uint idx; |
| uint out_idx; /* output index */ |
| } hndrte_log_t; |
| |
| typedef struct { |
| /* Virtual UART |
| * When there is no UART (e.g. Quickturn), the host should write a complete |
| * input line directly into cbuf and then write the length into vcons_in. |
| * This may also be used when there is a real UART (at risk of conflicting with |
| * the real UART). vcons_out is currently unused. |
| */ |
| volatile uint vcons_in; |
| volatile uint vcons_out; |
| |
| /* Output (logging) buffer |
| * Console output is written to a ring buffer log_buf at index log_idx. |
| * The host may read the output when it sees log_idx advance. |
| * Output will be lost if the output wraps around faster than the host polls. |
| */ |
| hndrte_log_t log; |
| |
| /* Console input line buffer |
| * Characters are read one at a time into cbuf until <CR> is received, then |
| * the buffer is processed as a command line. Also used for virtual UART. |
| */ |
| uint cbuf_idx; |
| char cbuf[CBUF_LEN]; |
| } hndrte_cons_t; |
| |
| hndrte_cons_t *hndrte_get_active_cons_state(void); |
| |
| #endif /* _HNDRTE_CONS_H */ |