/*
|
* Console support for RTE - for host use only.
|
*
|
* Copyright (C) 2020, Broadcom.
|
*
|
* 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.
|
*
|
*
|
* <<Broadcom-WL-IPTag/Dual:>>
|
*/
|
#ifndef _hnd_cons_h_
|
#define _hnd_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 */
|
|
#ifndef LOG_BUF_LEN
|
#if defined(BCMDBG) || defined (BCM_BIG_LOG)
|
#define LOG_BUF_LEN (16 * 1024)
|
#elif defined(ATE_BUILD)
|
#define LOG_BUF_LEN (2 * 1024)
|
#elif defined(BCMQT)
|
#define LOG_BUF_LEN (16 * 1024)
|
#else
|
#define LOG_BUF_LEN 1024
|
#endif
|
#endif /* LOG_BUF_LEN */
|
|
#ifdef BOOTLOADER_CONSOLE_OUTPUT
|
#undef RWL_MAX_DATA_LEN
|
#undef CBUF_LEN
|
#undef LOG_BUF_LEN
|
#define RWL_MAX_DATA_LEN (4 * 1024 + 8)
|
#define CBUF_LEN (RWL_MAX_DATA_LEN + 64)
|
#define LOG_BUF_LEN (16 * 1024)
|
#endif
|
|
typedef struct {
|
#ifdef BCMDONGLEHOST
|
uint32 buf; /* Can't be pointer on (64-bit) hosts */
|
#else
|
/* Physical buffer address, read by host code to dump console. */
|
char* PHYS_ADDR_N(buf);
|
#endif
|
uint buf_size;
|
uint idx;
|
uint out_idx; /* output index */
|
uint dump_idx; /* read idx for wl dump */
|
} hnd_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.
|
*/
|
hnd_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];
|
} hnd_cons_t;
|
|
#endif /* _hnd_cons_h_ */
|
