openbcm

Git mirror of https://github.com/Broadcom-Network-Switching-Software/OpenBCM
git clone git://git.finwo.net/mirror/broadcom/openbcm
Log | Files | Refs | README

ui_ram_defi.h (3996B)

      1 /* 
      2  * This license is set out in https://raw.githubusercontent.com/Broadcom-Network-Switching-Software/OpenBCM/master/Legal/LICENSE file.
      3  * 
      4  * Copyright 2007-2020 Broadcom Inc. All rights reserved.
      5 */
      6 #ifndef UI_RAM_DEFI_INCLUDED
      7 /* { */
      8 #define UI_RAM_DEFI_INCLUDED
      9 /*
     10  * General include file for reference design.
     11  */
     12 #include <appl/diag/dpp/ref_sys.h>
     13 /****************************************************************
     14 *NAME
     15 *  HISTORY_FIFO
     16 *TYPE: BUFFER
     17 *DATE: 31/JAN/2002
     18 *FUNCTION:
     19 *  STRUCTURE CONTAINING information on
     20 *  the history fifo of the CLI.
     21 *ORGANIZATION:
     22 *  STRUCTURE OF TYPE 'HISTORY_FIFO':
     23     unsigned int index -
     24       Next index to load in '*history_array'.
     25       Range: 0 -> (elements_in_array - 1)
     26     unsigned int num_loaded -
     27       Number of meaningful entries in '*history_array'.
     28       Can be up to 'elements_in_array'. Newest entry
     29       is pointed by (index - 1) [modulo the size of
     30       the array].
     31     unsigned int elements_in_array -
     32       Number of entries in 'history_array'.
     33     CURRENT_LINE **history_array -
     34       Array of pointers to structures of
     35       type CURRENT_LINE.
     36 *USAGE:
     37 *  See ORGANIZATION.
     38 *REMARKS:
     39 *  None.
     40 *SEE ALSO:
     41  */
     42 EXTERN
     43   HISTORY_FIFO
     44     History_fifo ;
     45 /****************************************************************
     46 *NAME
     47 *  CURRENT_LINE_PTR
     48 *TYPE: BUFFER
     49 *DATE: 15/JAN/2002
     50 *FUNCTION:
     51 *  POINTER TO STRUCTURE CONTAINING information on
     52 *  the current line being entered using CLI.
     53 *ORGANIZATION:
     54 *  POINTER TO STRUCTURE OF TYPE 'CURRENT_LINE':
     55 *USAGE:
     56 *  T. B. D.
     57 *REMARKS:
     58 *  This structure is updated as the user types in characters
     59 *  on the current CLI line. It is cleared when 'enter' is hit
     60 *  (on a line without errors) or when changing mode
     61 *  (telnet/local terminal)
     62 *SEE ALSO:
     63  */
     64 EXTERN
     65   CURRENT_LINE
     66     *Current_line_ptr ;
     67 /********************************************************
     68 *NAME
     69 *  Subjects_list
     70 *TYPE: BUFFER
     71 *DATE: 21/JAN/2002
     72 *FUNCTION:
     73 *  Pointer to array containing the  list of
     74 *  subject and related parameters.
     75 *ORGANIZATION:
     76 *  ARRAY OF STRUCTURES OF TYPE 'SUBJECT':
     77 *    int   subject_id -
     78 *      Identifier of this subject.
     79 *    char *subj_name -
     80 *      Ascii presentation of subject.
     81 *    PARAM *allowed_params -
     82 *      Array of structures of type PARAM. This is
     83 *      the list of parameters allowed for that
     84 *      subject.
     85 *USAGE:
     86 *  SEE ORGANIZATION.
     87 *REMARKS:
     88 *  This pointer initially points to the initial list
     89 *  of subjects in rom. At later stages, it may point to
     90 *  a RAM array, containing subjects added on line.
     91 *SEE ALSO:
     92  */
     93 EXTERN
     94   SUBJECT
     95     *Subjects_list ;
     96 /********************************************************
     97 *NAME
     98 *  Subjects_ascii_list
     99 *TYPE: BUFFER
    100 *DATE: 21/JAN/2002
    101 *FUNCTION:
    102 *  Pointer to ascii array (null terminated)containing
    103 *  the names of all subjects, separated by CR/LF.
    104 *ORGANIZATION:
    105 *  Standard 'C' string.
    106 *USAGE:
    107 *  SEE FUNCTION.
    108 *REMARKS:
    109 *  This pointer initially points to the initial list
    110 *  prepared from subjects in rom (using malloc). If
    111 *  subjects are added on line, memory should be released
    112 *  and reallocated for updated list.
    113 *SEE ALSO:
    114  */
    115 EXTERN
    116   char
    117     *Subjects_ascii_list ;
    118 /********************************************************
    119 *NAME
    120 *  Num_subjects
    121 *TYPE: BUFFER
    122 *DATE: 21/JAN/2002
    123 *FUNCTION:
    124 *  Number of subjects in the system.
    125 *ORGANIZATION:
    126 *  Unsigned int.
    127 *USAGE:
    128 *  SEE FUNCTION.
    129 *REMARKS:
    130 *  This number is initially deduced from the initial list
    131 *  prepared from subjects in rom. If subjects are added
    132 *  on line, this number must be updated.
    133 *SEE ALSO:
    134  */
    135 EXTERN
    136   unsigned int
    137     Num_subjects ;
    138 /********************************************************
    139 *NAME
    140 *  Memory_map
    141 *TYPE: BUFFER
    142 *DATE: 24/FEB/2002
    143 *FUNCTION:
    144 *  Pointer to array containing the  list of
    145 *  memory blocks and related parameters.
    146 *ORGANIZATION:
    147 *  ARRAY OF STRUCTURES OF TYPE 'MEMORY_MAP':
    148 *    See ui_pure_defi.h.
    149 *USAGE:
    150 *  See ui_pure_defi.h.
    151 *REMARKS:
    152 *  None.
    153 *SEE ALSO:
    154  */
    155 EXTERN
    156   MEMORY_MAP
    157     *Memory_map ;
    158 /* } */
    159 #endif