include/asm-ia64/sn/module.h

   1 /*
   2  * This file is subject to the terms and conditions of the GNU General Public
   3  * License.  See the file "COPYING" in the main directory of this archive
   4  * for more details.
   5  *
   6  * Copyright (C) 1992 - 1997, 2000-2003 Silicon Graphics, Inc. All rights reserved.
   7  */
   8 #ifndef _ASM_IA64_SN_MODULE_H
   9 #define _ASM_IA64_SN_MODULE_H
  10
  11 #ifdef  __cplusplus
  12 extern "C" {
  13 #endif
  14
  15
  16 #include <linux/config.h>
  17 #include <asm/sn/systeminfo.h>
  18 #include <asm/sn/klconfig.h>
  19 #include <asm/sn/ksys/elsc.h>
  20
  21 #define MODULE_MAX                      128
  22 #define MODULE_MAX_NODES                2
  23 #define MODULE_HIST_CNT                 16
  24 #define MAX_MODULE_LEN                  16
  25
  26 /* Well-known module IDs */
  27 #define MODULE_UNKNOWN          (-2) /* initial value of klconfig brd_module */
  28 /* #define INVALID_MODULE       (-1) ** generic invalid moduleid_t (arch.h) */
  29 #define MODULE_NOT_SET          0    /* module ID not set in sys ctlrs. */
  30
  31 /* parameter for format_module_id() */
  32 #define MODULE_FORMAT_BRIEF     1
  33 #define MODULE_FORMAT_LONG      2
  34
  35 /*
  36  *      Module id format
  37  *
  38  *      31-16   Rack ID (encoded class, group, number - 16-bit unsigned int)
  39  *       15-8   Brick type (8-bit ascii character)
  40  *        7-0   Bay (brick position in rack (0-63) - 8-bit unsigned int)
  41  *
  42  */
  43
  44 /*
  45  * Macros for getting the brick type
  46  */
  47 #define MODULE_BTYPE_MASK       0xff00
  48 #define MODULE_BTYPE_SHFT       8
  49 #define MODULE_GET_BTYPE(_m)    (((_m) & MODULE_BTYPE_MASK) >> MODULE_BTYPE_SHFT)
  50 #define MODULE_BT_TO_CHAR(_b)   ((char)(_b))
  51 #define MODULE_GET_BTCHAR(_m)   (MODULE_BT_TO_CHAR(MODULE_GET_BTYPE(_m)))
  52
  53 /*
  54  * Macros for getting the rack ID.
  55  */
  56 #define MODULE_RACK_MASK        0xffff0000
  57 #define MODULE_RACK_SHFT        16
  58 #define MODULE_GET_RACK(_m)     (((_m) & MODULE_RACK_MASK) >> MODULE_RACK_SHFT)
  59
  60 /*
  61  * Macros for getting the brick position
  62  */
  63 #define MODULE_BPOS_MASK        0x00ff
  64 #define MODULE_BPOS_SHFT        0
  65 #define MODULE_GET_BPOS(_m)     (((_m) & MODULE_BPOS_MASK) >> MODULE_BPOS_SHFT)
  66
  67 /*
  68  * Macros for constructing moduleid_t's
  69  */
  70 #define RBT_TO_MODULE(_r, _b, _t) ((_r) << MODULE_RACK_SHFT | \
  71                                    (_b) << MODULE_BPOS_SHFT | \
  72                                    (_t) << MODULE_BTYPE_SHFT)
  73
  74 /*
  75  * Macros for encoding and decoding rack IDs
  76  * A rack number consists of three parts:
  77  *   class (0==CPU/mixed, 1==I/O), group, number
  78  *
  79  * Rack number is stored just as it is displayed on the screen:
  80  * a 3-decimal-digit number.
  81  */
  82 #define RACK_CLASS_DVDR         100
  83 #define RACK_GROUP_DVDR         10
  84 #define RACK_NUM_DVDR           1
  85
  86 #define RACK_CREATE_RACKID(_c, _g, _n)  ((_c) * RACK_CLASS_DVDR +       \
  87         (_g) * RACK_GROUP_DVDR + (_n) * RACK_NUM_DVDR)
  88
  89 #define RACK_GET_CLASS(_r)              ((_r) / RACK_CLASS_DVDR)
  90 #define RACK_GET_GROUP(_r)              (((_r) - RACK_GET_CLASS(_r) *   \
  91             RACK_CLASS_DVDR) / RACK_GROUP_DVDR)
  92 #define RACK_GET_NUM(_r)                (((_r) - RACK_GET_CLASS(_r) *   \
  93             RACK_CLASS_DVDR - RACK_GET_GROUP(_r) *      \
  94             RACK_GROUP_DVDR) / RACK_NUM_DVDR)
  95
  96 /*
  97  * Macros for encoding and decoding rack IDs
  98  * A rack number consists of three parts:
  99  *   class      1 bit, 0==CPU/mixed, 1==I/O
 100  *   group      2 bits for CPU/mixed, 3 bits for I/O
 101  *   number     3 bits for CPU/mixed, 2 bits for I/O (1 based)
 102  */
 103 #define RACK_GROUP_BITS(_r)     (RACK_GET_CLASS(_r) ? 3 : 2)
 104 #define RACK_NUM_BITS(_r)       (RACK_GET_CLASS(_r) ? 2 : 3)
 105
 106 #define RACK_CLASS_MASK(_r)     0x20
 107 #define RACK_CLASS_SHFT(_r)     5
 108 #define RACK_ADD_CLASS(_r, _c)  \
 109         ((_r) |= (_c) << RACK_CLASS_SHFT(_r) & RACK_CLASS_MASK(_r))
 110
 111 #define RACK_GROUP_SHFT(_r)     RACK_NUM_BITS(_r)
 112 #define RACK_GROUP_MASK(_r)     \
 113         ( (((unsigned)1<<RACK_GROUP_BITS(_r)) - 1) << RACK_GROUP_SHFT(_r) )
 114 #define RACK_ADD_GROUP(_r, _g)  \
 115         ((_r) |= (_g) << RACK_GROUP_SHFT(_r) & RACK_GROUP_MASK(_r))
 116
 117 #define RACK_NUM_SHFT(_r)       0
 118 #define RACK_NUM_MASK(_r)       \
 119         ( (((unsigned)1<<RACK_NUM_BITS(_r)) - 1) << RACK_NUM_SHFT(_r) )
 120 #define RACK_ADD_NUM(_r, _n)    \
 121         ((_r) |= ((_n) - 1) << RACK_NUM_SHFT(_r) & RACK_NUM_MASK(_r))
 122
 123
 124 /*
 125  * Brick type definitions
 126  */
 127 #define MAX_BRICK_TYPES         256 /* brick type is stored as uchar */
 128
 129 extern char brick_types[];
 130
 131 #define MODULE_CBRICK           0
 132 #define MODULE_RBRICK           1
 133 #define MODULE_IBRICK           2
 134 #define MODULE_KBRICK           3
 135 #define MODULE_XBRICK           4
 136 #define MODULE_DBRICK           5
 137 #define MODULE_PBRICK           6
 138 #define MODULE_NBRICK           7
 139 #define MODULE_PEBRICK          8
 140 #define MODULE_PXBRICK          9
 141 #define MODULE_IXBRICK          10
 142
 143 /*
 144  * Moduleid_t comparison macros
 145  */
 146 /* Don't compare the brick type:  only the position is significant */
 147 #define MODULE_CMP(_m1, _m2)    (((_m1)&(MODULE_RACK_MASK|MODULE_BPOS_MASK)) -\
 148                                  ((_m2)&(MODULE_RACK_MASK|MODULE_BPOS_MASK)))
 149 #define MODULE_MATCH(_m1, _m2)  (MODULE_CMP((_m1),(_m2)) == 0)
 150
 151 typedef struct module_s module_t;
 152
 153 struct module_s {
 154     moduleid_t          id;             /* Module ID of this module        */
 155
 156     spinlock_t          lock;           /* Lock for this structure         */
 157
 158     /* List of nodes in this module */
 159     cnodeid_t           nodes[MODULE_MAX_NODES];
 160     geoid_t             geoid[MODULE_MAX_NODES];
 161     struct {
 162                 char    moduleid[8];
 163     } io[MODULE_MAX_NODES];
 164     int                 nodecnt;        /* Number of nodes in array        */
 165     /* Fields for Module System Controller */
 166     int                 mesgpend;       /* Message pending                 */
 167     int                 shutdown;       /* Shutdown in progress            */
 168     struct semaphore    thdcnt;         /* Threads finished counter        */
 169     time_t              intrhist[MODULE_HIST_CNT];
 170     int                 histptr;
 171
 172     int                 hbt_active;     /* MSC heartbeat monitor active    */
 173     uint64_t            hbt_last;       /* RTC when last heartbeat sent    */
 174
 175     /* Module serial number info */
 176     union {
 177         char            snum_str[MAX_SERIAL_NUM_SIZE];   /* used by CONFIG_SGI_IP27    */
 178         uint64_t        snum_int;                        /* used by speedo */
 179     } snum;
 180     int                 snum_valid;
 181
 182     int                 disable_alert;
 183     int                 count_down;
 184
 185     /* System serial number info (used by SN1) */
 186     char                sys_snum[MAX_SERIAL_NUM_SIZE];
 187     int                 sys_snum_valid;
 188 };
 189
 190 /* module.c */
 191 extern module_t        *modules[MODULE_MAX];    /* Indexed by cmoduleid_t   */
 192 extern int              nummodules;
 193
 194 extern module_t        *module_lookup(moduleid_t id);
 195
 196 extern int              get_kmod_info(cmoduleid_t cmod,
 197                                       module_info_t *mod_info);
 198 extern int              get_kmod_sys_snum(cmoduleid_t cmod,
 199                                           char *snum);
 200
 201 extern void             format_module_id(char *buffer, moduleid_t m, int fmt);
 202 extern int              parse_module_id(char *buffer);
 203
 204 #ifdef  __cplusplus
 205 }
 206 #endif
 207
 208 #endif /* _ASM_IA64_SN_MODULE_H */