include/asm-ia64/sn/xtalk/xwidget.h

   1 /* $Id$
   2  *
   3  * This file is subject to the terms and conditions of the GNU General Public
   4  * License.  See the file "COPYING" in the main directory of this archive
   5  * for more details.
   6  *
   7  * Copyright (C) 1992 - 1997, 2000-2001 Silicon Graphics, Inc.
   8  * Copyright (C) 2000 by Colin Ngam
   9  */
  10 #ifndef __ASM_SN_XTALK_XWIDGET_H__
  11 #define __ASM_SN_XTALK_XWIDGET_H__
  12
  13 /*
  14  * xwidget.h - generic crosstalk widget header file
  15  */
  16
  17 #include <asm/sn/xtalk/xtalk.h>
  18 #ifndef __ASSEMBLY__
  19 #include <asm/sn/cdl.h>
  20 #endif /* __ASSEMBLY__ */
  21
  22 #ifdef LITTLE_ENDIAN
  23 #define WIDGET_ID                       0x00
  24 #define WIDGET_STATUS                   0x08
  25 #define WIDGET_ERR_UPPER_ADDR           0x10
  26 #define WIDGET_ERR_LOWER_ADDR           0x18
  27 #define WIDGET_CONTROL                  0x20
  28 #define WIDGET_REQ_TIMEOUT              0x28
  29 #define WIDGET_INTDEST_UPPER_ADDR       0x30
  30 #define WIDGET_INTDEST_LOWER_ADDR       0x38
  31 #define WIDGET_ERR_CMD_WORD             0x40
  32 #define WIDGET_LLP_CFG                  0x48
  33 #define WIDGET_TFLUSH                   0x50
  34 #else   /* !LITTLE_ENDIAN */
  35 #define WIDGET_ID                       0x04
  36 #define WIDGET_STATUS                   0x0c
  37 #define WIDGET_ERR_UPPER_ADDR           0x14
  38 #define WIDGET_ERR_LOWER_ADDR           0x1c
  39 #define WIDGET_CONTROL                  0x24
  40 #define WIDGET_REQ_TIMEOUT              0x2c
  41 #define WIDGET_INTDEST_UPPER_ADDR       0x34
  42 #define WIDGET_INTDEST_LOWER_ADDR       0x3c
  43 #define WIDGET_ERR_CMD_WORD             0x44
  44 #define WIDGET_LLP_CFG                  0x4c
  45 #define WIDGET_TFLUSH                   0x54
  46 #endif
  47
  48 /* WIDGET_ID */
  49 #define WIDGET_REV_NUM                  0xf0000000
  50 #define WIDGET_PART_NUM                 0x0ffff000
  51 #define WIDGET_MFG_NUM                  0x00000ffe
  52 #define WIDGET_REV_NUM_SHFT             28
  53 #define WIDGET_PART_NUM_SHFT            12
  54 #define WIDGET_MFG_NUM_SHFT             1
  55
  56 #define XWIDGET_PART_NUM(widgetid) (((widgetid) & WIDGET_PART_NUM) >> WIDGET_PART_NUM_SHFT)
  57 #define XWIDGET_REV_NUM(widgetid) (((widgetid) & WIDGET_REV_NUM) >> WIDGET_REV_NUM_SHFT)
  58 #define XWIDGET_MFG_NUM(widgetid) (((widgetid) & WIDGET_MFG_NUM) >> WIDGET_MFG_NUM_SHFT)
  59 #define XWIDGET_PART_REV_NUM(widgetid) ((XWIDGET_PART_NUM(widgetid) << 4) | \
  60                                         XWIDGET_REV_NUM(widgetid))
  61 #define XWIDGET_PART_REV_NUM_REV(partrev) (partrev & 0xf)
  62
  63 /* WIDGET_STATUS */
  64 #define WIDGET_LLP_REC_CNT              0xff000000
  65 #define WIDGET_LLP_TX_CNT               0x00ff0000
  66 #define WIDGET_PENDING                  0x0000001f
  67
  68 /* WIDGET_ERR_UPPER_ADDR */
  69 #define WIDGET_ERR_UPPER_ADDR_ONLY      0x0000ffff
  70
  71 /* WIDGET_CONTROL */
  72 #define WIDGET_F_BAD_PKT                0x00010000
  73 #define WIDGET_LLP_XBAR_CRD             0x0000f000
  74 #define WIDGET_LLP_XBAR_CRD_SHFT        12
  75 #define WIDGET_CLR_RLLP_CNT             0x00000800
  76 #define WIDGET_CLR_TLLP_CNT             0x00000400
  77 #define WIDGET_SYS_END                  0x00000200
  78 #define WIDGET_MAX_TRANS                0x000001f0
  79 #define WIDGET_PCI_SPEED                0x00000030
  80 #define WIDGET_PCI_SPEED_SHFT           4
  81 #define WIDGET_PCI_SPEED_33MHZ 0
  82 #define WIDGET_PCI_SPEED_66MHZ 1
  83 #define WIDGET_WIDGET_ID                0x0000000f
  84
  85 /* WIDGET_INTDEST_UPPER_ADDR */
  86 #define WIDGET_INT_VECTOR               0xff000000
  87 #define WIDGET_INT_VECTOR_SHFT          24
  88 #define WIDGET_TARGET_ID                0x000f0000
  89 #define WIDGET_TARGET_ID_SHFT           16
  90 #define WIDGET_UPP_ADDR                 0x0000ffff
  91
  92 /* WIDGET_ERR_CMD_WORD */
  93 #define WIDGET_DIDN                     0xf0000000
  94 #define WIDGET_SIDN                     0x0f000000
  95 #define WIDGET_PACTYP                   0x00f00000
  96 #define WIDGET_TNUM                     0x000f8000
  97 #define WIDGET_COHERENT                 0x00004000
  98 #define WIDGET_DS                       0x00003000
  99 #define WIDGET_GBR                      0x00000800
 100 #define WIDGET_VBPM                     0x00000400
 101 #define WIDGET_ERROR                    0x00000200
 102 #define WIDGET_BARRIER                  0x00000100
 103
 104 /* WIDGET_LLP_CFG */
 105 #define WIDGET_LLP_MAXRETRY             0x03ff0000
 106 #define WIDGET_LLP_MAXRETRY_SHFT        16
 107 #define WIDGET_LLP_NULLTIMEOUT          0x0000fc00
 108 #define WIDGET_LLP_NULLTIMEOUT_SHFT     10
 109 #define WIDGET_LLP_MAXBURST             0x000003ff
 110 #define WIDGET_LLP_MAXBURST_SHFT        0
 111
 112 /*
 113  * according to the crosstalk spec, only 32-bits access to the widget
 114  * configuration registers is allowed.  some widgets may allow 64-bits
 115  * access but software should not depend on it.  registers beyond the
 116  * widget target flush register are widget dependent thus will not be
 117  * defined here
 118  */
 119 #ifndef __ASSEMBLY__
 120 typedef uint32_t      widgetreg_t;
 121
 122 /* widget configuration registers */
 123 typedef volatile struct widget_cfg {
 124 #ifdef LITTLE_ENDIAN
 125 /*
 126  * we access these through synergy unswizzled space, so the address
 127  * gets twiddled (i.e. references to 0x4 actually go to 0x0 and vv.)
 128  * That's why we put the register first and filler second.
 129  */
 130     widgetreg_t             w_id;       /* 0x04 */
 131     widgetreg_t             w_pad_0;    /* 0x00 */
 132     widgetreg_t             w_status;   /* 0x0c */
 133     widgetreg_t             w_pad_1;    /* 0x08 */
 134     widgetreg_t             w_err_upper_addr;   /* 0x14 */
 135     widgetreg_t             w_pad_2;    /* 0x10 */
 136     widgetreg_t             w_err_lower_addr;   /* 0x1c */
 137     widgetreg_t             w_pad_3;    /* 0x18 */
 138     widgetreg_t             w_control;  /* 0x24 */
 139     widgetreg_t             w_pad_4;    /* 0x20 */
 140     widgetreg_t             w_req_timeout;      /* 0x2c */
 141     widgetreg_t             w_pad_5;    /* 0x28 */
 142     widgetreg_t             w_intdest_upper_addr;       /* 0x34 */
 143     widgetreg_t             w_pad_6;    /* 0x30 */
 144     widgetreg_t             w_intdest_lower_addr;       /* 0x3c */
 145     widgetreg_t             w_pad_7;    /* 0x38 */
 146     widgetreg_t             w_err_cmd_word;     /* 0x44 */
 147     widgetreg_t             w_pad_8;    /* 0x40 */
 148     widgetreg_t             w_llp_cfg;  /* 0x4c */
 149     widgetreg_t             w_pad_9;    /* 0x48 */
 150     widgetreg_t             w_tflush;   /* 0x54 */
 151     widgetreg_t             w_pad_10;   /* 0x50 */
 152 #else
 153     widgetreg_t             w_pad_0;    /* 0x00 */
 154     widgetreg_t             w_id;       /* 0x04 */
 155     widgetreg_t             w_pad_1;    /* 0x08 */
 156     widgetreg_t             w_status;   /* 0x0c */
 157     widgetreg_t             w_pad_2;    /* 0x10 */
 158     widgetreg_t             w_err_upper_addr;   /* 0x14 */
 159     widgetreg_t             w_pad_3;    /* 0x18 */
 160     widgetreg_t             w_err_lower_addr;   /* 0x1c */
 161     widgetreg_t             w_pad_4;    /* 0x20 */
 162     widgetreg_t             w_control;  /* 0x24 */
 163     widgetreg_t             w_pad_5;    /* 0x28 */
 164     widgetreg_t             w_req_timeout;      /* 0x2c */
 165     widgetreg_t             w_pad_6;    /* 0x30 */
 166     widgetreg_t             w_intdest_upper_addr;       /* 0x34 */
 167     widgetreg_t             w_pad_7;    /* 0x38 */
 168     widgetreg_t             w_intdest_lower_addr;       /* 0x3c */
 169     widgetreg_t             w_pad_8;    /* 0x40 */
 170     widgetreg_t             w_err_cmd_word;     /* 0x44 */
 171     widgetreg_t             w_pad_9;    /* 0x48 */
 172     widgetreg_t             w_llp_cfg;  /* 0x4c */
 173     widgetreg_t             w_pad_10;   /* 0x50 */
 174     widgetreg_t             w_tflush;   /* 0x54 */
 175 #endif /* LITTLE_ENDIAN */
 176 } widget_cfg_t;
 177
 178 #ifdef LITTLE_ENDIAN
 179 typedef struct {
 180     unsigned                other:8;
 181     unsigned                bo:1;
 182     unsigned                error:1;
 183     unsigned                vbpm:1;
 184     unsigned                gbr:1;
 185     unsigned                ds:2;
 186     unsigned                ct:1;
 187     unsigned                tnum:5;
 188     unsigned                pactyp:4;
 189     unsigned                sidn:4;
 190     unsigned                didn:4;
 191 } w_err_cmd_word_f;
 192 #else
 193 typedef struct {
 194     unsigned                didn:4;
 195     unsigned                sidn:4;
 196     unsigned                pactyp:4;
 197     unsigned                tnum:5;
 198     unsigned                ct:1;
 199     unsigned                ds:2;
 200     unsigned                gbr:1;
 201     unsigned                vbpm:1;
 202     unsigned                error:1;
 203     unsigned                bo:1;
 204     unsigned                other:8;
 205 } w_err_cmd_word_f;
 206 #endif
 207
 208 #ifdef LITTLE_ENDIAN
 209 typedef union {
 210     w_err_cmd_word_f        f;
 211     widgetreg_t             r;
 212 } w_err_cmd_word_u;
 213 #else
 214 typedef union {
 215     widgetreg_t             r;
 216     w_err_cmd_word_f        f;
 217 } w_err_cmd_word_u;
 218 #endif
 219
 220 /* IO widget initialization function */
 221 typedef struct xwidget_info_s *xwidget_info_t;
 222
 223 /*
 224  * Crosstalk Widget Hardware Identification, as defined in the Crosstalk spec.
 225  */
 226 #ifdef LITTLE_ENDIAN
 227 typedef struct xwidget_hwid_s {
 228     xwidget_mfg_num_t       mfg_num;
 229     xwidget_rev_num_t       rev_num;
 230     xwidget_part_num_t      part_num;
 231 }                      *xwidget_hwid_t;
 232 #else
 233 typedef struct xwidget_hwid_s {
 234     xwidget_part_num_t      part_num;
 235     xwidget_rev_num_t       rev_num;
 236     xwidget_mfg_num_t       mfg_num;
 237 }                      *xwidget_hwid_t;
 238 #endif
 239
 240
 241 /*
 242  * Returns 1 if a driver that handles devices described by hwid1 is able
 243  * to manage a device with hardwareid hwid2.  NOTE: We don't check rev
 244  * numbers at all.
 245  */
 246 #define XWIDGET_HARDWARE_ID_MATCH(hwid1, hwid2) \
 247         (((hwid1)->part_num == (hwid2)->part_num) && \
 248         (((hwid1)->mfg_num == XWIDGET_MFG_NUM_NONE) || \
 249         ((hwid2)->mfg_num == XWIDGET_MFG_NUM_NONE) || \
 250         ((hwid1)->mfg_num == (hwid2)->mfg_num)))
 251
 252
 253 /* Generic crosstalk widget initialization interface */
 254 #if __KERNEL__
 255
 256 extern int              xwidget_driver_register(xwidget_part_num_t part_num,
 257                                                 xwidget_mfg_num_t mfg_num,
 258                                                 char *driver_prefix,
 259                                                 unsigned flags);
 260
 261 extern void             xwidget_driver_unregister(char *driver_prefix);
 262
 263 extern int              xwidget_register(struct xwidget_hwid_s *hwid,
 264                                          devfs_handle_t dev,
 265                                          xwidgetnum_t id,
 266                                          devfs_handle_t master,
 267                                          xwidgetnum_t targetid,
 268                                          async_attach_t aa);
 269
 270 extern int              xwidget_unregister(devfs_handle_t);
 271
 272 extern void             xwidget_reset(devfs_handle_t xwidget);
 273 extern void             xwidget_gfx_reset(devfs_handle_t xwidget);
 274 extern char             *xwidget_name_get(devfs_handle_t xwidget);
 275
 276 /* Generic crosstalk widget information access interface */
 277 extern xwidget_info_t   xwidget_info_chk(devfs_handle_t widget);
 278 extern xwidget_info_t   xwidget_info_get(devfs_handle_t widget);
 279 extern void             xwidget_info_set(devfs_handle_t widget, xwidget_info_t widget_info);
 280 extern devfs_handle_t     xwidget_info_dev_get(xwidget_info_t xwidget_info);
 281 extern xwidgetnum_t     xwidget_info_id_get(xwidget_info_t xwidget_info);
 282 extern int              xwidget_info_type_get(xwidget_info_t xwidget_info);
 283 extern int              xwidget_info_state_get(xwidget_info_t xwidget_info);
 284 extern devfs_handle_t     xwidget_info_master_get(xwidget_info_t xwidget_info);
 285 extern xwidgetnum_t     xwidget_info_masterid_get(xwidget_info_t xwidget_info);
 286 extern xwidget_part_num_t xwidget_info_part_num_get(xwidget_info_t xwidget_info);
 287 extern xwidget_rev_num_t xwidget_info_rev_num_get(xwidget_info_t xwidget_info);
 288 extern xwidget_mfg_num_t xwidget_info_mfg_num_get(xwidget_info_t xwidget_info);
 289
 290 extern xwidgetnum_t hub_widget_id(nasid_t);
 291
 292
 293
 294 /*
 295  * TBD: DELETE THIS ENTIRE STRUCTURE!  Equivalent is now in
 296  * xtalk_private.h: xwidget_info_s
 297  * This is just here for now because we still have a lot of
 298  * junk referencing it.
 299  * However, since nobody looks inside ...
 300  */
 301 typedef struct v_widget_s {
 302     unsigned                v_widget_s_is_really_empty;
 303 #define v_widget_s_is_really_empty      and using this would be a syntax error.
 304 } v_widget_t;
 305 #endif                          /* _KERNEL */
 306
 307 #endif                          /* __ASSEMBLY__ */
 308
 309 #endif                          /* __ASM_SN_XTALK_XWIDGET_H__ */