osfmk/sys/sdi.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  * @OSF_COPYRIGHT@
  25  *
  26  */
  27 /*
  28  * HISTORY
  29  *
  30  * Revision 1.1.1.1  1998/09/22 21:05:48  wsanchez
  31  * Import of Mac OS X kernel (~semeria)
  32  *
  33  * Revision 1.1.1.1  1998/03/07 02:25:59  wsanchez
  34  * Import of OSF Mach kernel (~mburg)
  35  *
  36  * Revision 1.1.7.1  1996/09/17  16:34:56  bruel
  37  *      removed size_t, already defined in types.h.
  38  *      [96/09/17            bruel]
  39  *
  40  * Revision 1.1.4.1  1996/04/17  17:48:54  davidp
  41  *      Created for use with SVR4 drivers.
  42  *      [1996/04/11  13:19:26  davidp]
  43  *
  44  * Revision 1.1.1.2  1996/03/04  17:53:46  calvert
  45  *      Created for use with SVR4 drivers.
  46  *
  47  * $EndLog$
  48  */
  49 /* In vi use ":set ts=4" to edit/view this file
  50  */
  51 #ifndef _SYS_SDI_H_
  52 #define _SYS_SDI_H_     1
  53
  54 #include "scsi/scsi_endian.h"
  55
  56 typedef u_long  paddr_t;
  57 typedef u_int   rm_key_t;
  58
  59 typedef long    hba_clock_t;
  60
  61 typedef u_long  major_t;
  62 typedef u_long  minor_t;
  63
  64 typedef u_long  hba_buf_t;      /* just to satisfy declaration */
  65 typedef u_long  hba_uio_t;      /* just to satisfy declaration */
  66
  67
  68 struct ver_no {
  69         uchar_t                 sv_release;
  70         uchar_t                 sv_machine;
  71         short                   sv_modes;
  72 };
  73
  74 struct hba_idata_v4 {
  75         int                             version_num;
  76         char                    *name;
  77         uchar_t                 ha_id;
  78         ulong_t                 ioaddr1;
  79         int                             dmachan1;
  80         int                             iov;
  81         int                             cntlr;
  82         int                             active;
  83         ulong_t                 idata_memaddr;
  84         uchar_t                 idata_ctlorder;
  85         uchar_t                 idata_nbus;
  86         ushort_t                idata_ntargets;
  87         ushort_t                idata_nluns;
  88         rm_key_t                idata_rmkey;
  89         void                    *idata_intrcookie;
  90         int                             idata_cpubind;
  91 };
  92
  93 struct hba_idata {
  94         int                             version_num;
  95         char                    *name;
  96         uchar_t                 ha_id;
  97         ulong_t                 ioaddr1;
  98         int                             dmachan1;
  99         int                             iov;
 100         int                             cntlr;
 101         int                             active;
 102 };
 103
 104 #define HBA_SVR4_2              1
 105 #define HBA_SVR4_2_2    2
 106 #define HBA_SVR4_2MP    3
 107
 108 #define HBA_VMASK               0xffff
 109
 110 #define HBA_IDATA_EXT   0x10000
 111 #define HBA_EXT_INFO    0x20000
 112 #define HBA_AUTOCONF    0x40000
 113
 114 #define VID_LEN         8
 115 #define PID_LEN         16
 116 #define REV_LEN         4
 117
 118 #define INQ_LEN         VID_LEN+PID_LEN+1
 119 #define INQ_EXLEN       INQ_LEN+REV_LEN
 120
 121 struct ident {
 122         BITFIELD_2( unsigned char,
 123                                         id_type : 5,
 124                                         id_pqual : 3);
 125         BITFIELD_2(unsigned char,
 126                                         id_qualif : 7,
 127                                         id_rmb : 1);
 128         uchar_t                 id_ver;
 129         BITFIELD_2(unsigned char,
 130                                         id_form : 4,
 131                                         id_res1 : 4);
 132         uchar_t                 id_len;
 133         uchar_t                 id_vu [3];
 134         char                    id_vendor [VID_LEN];
 135         char                    id_prod [PID_LEN];
 136         char                    id_revnum [REV_LEN];
 137 };
 138
 139 #define SCSI_INQ_CON    0x0
 140 #define SCSI_INQ_TC             0x1
 141 #define SCSI_INQ_TNC    0x3
 142
 143 struct scsi_adr {
 144         int     scsi_ctl;
 145         int     scsi_target;
 146         int     scsi_lun;
 147         int     scsi_bus;
 148 };
 149
 150 struct scsi_ad {
 151         ulong_t                 sa_major;
 152         ulong_t                 sa_minor;
 153         uchar_t                 sa_lun;
 154         BITFIELD_2(unsigned char,
 155                                         sa_bus : 3,
 156                                         sa_exta : 5);
 157         short                   sa_ct;
 158 };
 159
 160 /* sa_ct */
 161 #define SDI_SA_CT(c,t)  (((c) << 3) | ((t) & 0x07))
 162 #define SDI_HAN(sa)             (((sa)->sa_ct >> 3) & 0x07)
 163 #define SDI_TCN(sa)             ((sa)->sa_ct & 0x07)
 164
 165 #define SDI_ETCN(sa)            ((sa)->sa_exta)
 166 #define SDI_EHAN(sa)            (((sa)->sa_ct >> 3) & 0x1f)
 167
 168 struct sdi_edt {
 169         struct sdi_edt  *hash_p;
 170         short                   hba_no;
 171         uchar_t                 scsi_id;
 172         uchar_t                 lun;
 173         struct owner    *curdrv;
 174         struct owner    *owner_list;
 175         ulong_t                 res1;
 176         int                             pdtype;
 177         uchar_t                 iotype;
 178         char                    inquiry [INQ_EXLEN];
 179         struct scsi_adr scsi_adr;
 180         ulong_t                 memaddr;
 181         uchar_t                 ctlorder;
 182         struct ident    edt_ident;
 183 };
 184
 185 /* iotype */
 186 #define F_DMA           0x001
 187 #define F_DMA_24        F_DMA
 188 #define F_PIO           0x002
 189 #define F_SCGTH         0x004
 190 #define F_RMB           0x008
 191 #define F_DMA_32        0x010
 192 #define F_HDWREA        0x020
 193 #define F_RESID         0x040
 194
 195 struct mod_operations {
 196         int     (*modm_install)(void);
 197         int     (*modm_remove)(void);
 198         int     (*modm_info)(void);
 199         int     (*modm_bind)(void);
 200 };
 201
 202 struct modlink {
 203         struct mod_operations   *ml_ops;
 204         void                                    *ml_type_data;
 205 };
 206
 207 struct mod_type_data {
 208         char    *mtd_info;
 209         void    *mtd_pdata;
 210 };
 211
 212 struct modwrapper {
 213         int                             mw_rev;
 214         int                             (*mw_load)(void);
 215         int                             (*mw_unload)(void);
 216         void                    (*mw_halt)(void);
 217         void                    *mw_conf_data;
 218         struct modlink  *mw_modlink;
 219 };
 220
 221 struct hbadata {
 222         struct xsb *sb;
 223 };
 224
 225 typedef struct physreq {
 226         paddr_t         phys_align;
 227         paddr_t         phys_boundary;
 228         uchar_t         phys_dmasize;
 229         uchar_t         phys_max_scgth;
 230         uchar_t         phys_flags;
 231         void            *phys_brkup_poolp;
 232 } physreq_t;
 233
 234
 235 typedef struct bcb {
 236         uchar_t         bcb_addrtypes;
 237         uchar_t         bcb_flags;
 238         size_t          bcb_max_xfer;
 239         size_t          bcb_granularity;
 240         physreq_t       *bcb_physreqp;
 241 } bcb_t;
 242
 243 struct hbagetinfo {
 244         char    *name;
 245         char    iotype;
 246         bcb_t   *bcbp;
 247 };
 248
 249 struct hba_info {
 250         int                             *hba_flag;
 251         ulong_t                 max_xfer;
 252         long                    (*hba_freeblk)(struct hbadata *hdp, int cntlr);
 253         struct hbadata  *(*hba_getblk)(int flag, int cntlr);
 254         long                    (*hba_icmd)(struct hbadata *hdp, int flag);
 255         void                    (*hba_getinfo)(struct scsi_ad *sap,
 256                                                 struct hbagetinfo *hgip);
 257         long                    (*hba_send)(struct hbadata *hdp, int flag);
 258         int                             (*hba_xlat)(struct hbadata *hdp, int bflag, void *procp,
 259                                                 int flag);
 260         int                             (*hba_open)(void);
 261         int                             (*hba_close)(void);
 262         int                             (*hba_ioctl)(void);
 263 };
 264
 265 /* hba_flag */
 266 #define HBA_MP          0x01
 267 #define HBA_HOT         0x02
 268 #define HBA_TIMEOUT     0x04
 269
 270 #define SC_EXHAN(minor) (((minor) >> 5) & 0x1f)
 271 #define SC_EXTCN(minor) ((((minor) >> 2) & 0x07) | ((minor >> 7) & 0x18))
 272 #define SC_EXLUN(minor) (((minor) & 0x03) | ((minor>>10) & 0x1C))
 273 #define SC_BUS(minor)   (((minor) >> 15) & 0x07)
 274
 275 #define SC_MKMINOR(h,t,l,b)     ( \
 276                                                                 (((h) & 0x1f) << 5) | \
 277                                                                 (((t) & 0x07) << 2) | (((t) & 0x18) << 7) | \
 278                                                                 ((l) & 0x03) | (((l) & 0x1c) << 10) | \
 279                                                                 (((b) & 0x07) << 15) \
 280                                                         )
 281
 282 #define SDI_NAMESZ              49
 283
 284 #define SM_POOLSIZE             28
 285 #define LG_POOLSIZE             (sizeof (struct xsb))
 286
 287 #define SCB_TYPE        1
 288 #define ISCB_TYPE       2
 289 #define SFB_TYPE        3
 290
 291 #define SCB_WRITE       0x00
 292 #define SCB_READ        0x01
 293 #define SCB_LINK        0x02
 294 #define SCB_HAAD        0x04
 295 #define SCB_PARTBLK     0x08
 296
 297 #define SDI_NOALLOC     0x00000000
 298 #define SDI_ASW         0x00000001
 299 #define SDI_LINKF0      0x00000002
 300 #define SDI_LINKF1      0x00000003
 301 #define SDI_QFLUSH      0xE0000004
 302 #define SDI_ABORT       0xF0000005
 303 #define SDI_RESET       0xF0000006
 304 #define SDI_CRESET      0xD0000007
 305 #define SDI_V2PERR      0xA0000008
 306 #define SDI_TIME        0xD0000009
 307 #define SDI_NOTEQ       0x8000000A
 308 #define SDI_HAERR       0xE000000B
 309 #define SDI_MEMERR      0xA000000C
 310 #define SDI_SBUSER      0xA000000D
 311 #define SDI_CKSTAT      0xD000000E
 312 #define SDI_SCBERR      0x8000000F
 313 #define SDI_OOS         0xA0000010
 314 #define SDI_NOSELE      0x90000011
 315 #define SDI_MISMAT      0x90000012
 316 #define SDI_PROGRES     0x00000013
 317 #define SDI_UNUSED      0x00000014
 318 #define SDI_ONEIC       0x80000017
 319 #define SDI_SFBERR      0x80000019
 320 #define SDI_TCERR       0x9000001A
 321
 322 #define SDI_ERROR       0x80000000
 323 #define SDI_RETRY       0x40000000
 324 #define SDI_MESS        0x20000000
 325 #define SDI_SUSPEND     0x10000000
 326
 327 #define SFB_NOPF                0x00
 328 #define SFB_RESETM              0x01
 329 #define SFB_ABORTM              0x02
 330 #define SFB_FLUSHR              0x03
 331 #define SFB_RESUME              0x04
 332 #define SFB_SUSPEND             0x05
 333 #define SFB_ADD_DEV             0x06
 334 #define SFB_RM_DEV              0x07
 335 #define SFB_PAUSE               0x08
 336 #define SFB_CONTINUE    0x09
 337
 338 #define SDI_386_AT              0x06
 339 #define SDI_386_MCA             0x07
 340 #define SDI_386_EISA    0x08
 341
 342 #define SDI_RET_OK              0
 343 #define SDI_RET_ERR             -1
 344 #define SDI_RET_RETRY   1
 345
 346 #define SDI_SEND                0x0081
 347 #define SDI_TRESET              0x0082
 348 #define SDI_BRESET              0x0084
 349 #define HA_VER                  0x0083
 350 #define SDI_RESERVE             0x0085
 351 #define SDI_RELEASE             0x0086
 352 #define SDI_RESTAT              0x0087
 353 #define HA_GETPARMS             0x008a
 354 #define IHA_GETPARMS    0x008b
 355 #define HA_SETPARMS             0x008c
 356 #define IHA_SETPARMS    0x008d
 357 #define HA_GETPPARMS    0x008e
 358
 359 struct sense {
 360         uchar_t                 sd_pad0;
 361         BITFIELD_2(unsigned char,
 362                                         sd_errc : 7,
 363                                         sd_valid : 1);
 364         uchar_t                 sd_res1;
 365         BITFIELD_5(unsigned char,
 366                                         sd_key : 4,
 367                                         sd_res2 : 1,
 368                                         sd_ili : 1,
 369                                         sd_eom : 1,
 370                                         sd_fm : 1);
 371         uint_t                  sd_ba;
 372         uchar_t                 sd_len;
 373         uchar_t                 sd_res3 [4];
 374         uchar_t                 sd_sencode;
 375         uchar_t                 sd_qualifier;
 376         uchar_t                 sd_fru;
 377         BITFIELD_5(unsigned char,
 378                                         sd_bitpt : 3,
 379                                         sd_bpv : 1,
 380                                         sd_res4 : 2,
 381                                         sd_cd : 1,
 382                                         sd_res5 : 1);
 383         uchar_t                 sd_field [2];
 384         uchar_t                 sd_res6;
 385         uchar_t                 sd_buffer;
 386         uchar_t                 sd_res7 [2];
 387 };
 388
 389
 390 struct sb_extra {
 391         struct sense    sb_sense;
 392 };
 393
 394 #define sc_priv         sc_extra
 395
 396 struct sb;
 397
 398 struct scb {
 399         ulong_t                 sc_comp_code;
 400         void                    *sc_extra;
 401         void                    (*sc_int)(struct sb *sbp);
 402         caddr_t                 sc_cmdpt;
 403         caddr_t                 sc_datapt;
 404         long                    sc_wd;
 405         time_t                  sc_time;
 406         struct scsi_ad  sc_dev;
 407         ushort_t                sc_mode;
 408         uchar_t                 sc_status;
 409         char                    sc_fill;
 410         struct sb               *sc_link;
 411         long                    sc_cmdsz;
 412         long                    sc_datasz;
 413         long                    sc_resid;
 414         hba_clock_t             sc_start;
 415 };
 416
 417 struct sfb {
 418         ulong_t                 sf_comp_code;
 419         char                    *sf_priv;
 420         void                    (*sf_int)(struct sb *sbp);
 421         struct scsi_ad  sf_dev;
 422         ulong_t                 sf_func;
 423         int                             sf_wd;
 424 };
 425
 426 struct sb {
 427         ulong_t                 sb_type;
 428         union {
 429                 struct scb      b_scb;
 430                 struct sfb      b_sfb;
 431         } sb_b;
 432 };
 433
 434 #define SCB             sb_b.b_scb
 435 #define SFB             sb_b.b_sfb
 436
 437 struct xsb {
 438         struct sb               sb;
 439         struct hbadata  *hbadata_p;
 440         struct owner    *owner_p;
 441         struct sb_extra extra;
 442 };
 443
 444 #define S_GOOD          0X00
 445 #define S_CKCON         0X02
 446 #define S_METGD         0X04
 447 #define S_BUSY          0X08
 448 #define S_INGD          0X10
 449 #define S_INMET         0X12
 450 #define S_RESER         0X18
 451 #define S_CTERM         0x22
 452 #define S_QFULL         0x28
 453
 454 #define SLEEP                   0
 455 #define NOSLEEP                 1
 456
 457 #define KM_SLEEP                SLEEP
 458 #define KM_NOSLEEP              NOSLEEP
 459 #define KM_DMA                  2
 460 #define KM_REQ_DMA              4
 461 #define KM_PHYSCONTIG   8
 462
 463 struct mod_drvintr {
 464         ushort_t        di_magic;
 465         ushort_t        di_version;
 466         char            *di_modname;
 467         int                     *di_devflagp;
 468         void            (*di_handler)(int vect);
 469         void            *di_hook;
 470 };
 471
 472 #define MOD_INTR_MAGIC  0xEB13
 473 #define MOD_INTR_VER    1
 474
 475 struct o_mod_drvintr {
 476         struct intr_info        *drv_intrinfo;
 477         void                            (*ihndler)(int vect);
 478 };
 479
 480 #define MOD_INTRVER_MASK        0xff000000
 481 #define MOD_INTRVER_42          0x01000000
 482
 483 #define INTRVER(infop)  ((unsigned int)((infop)->ivect_no & MOD_INTRVER_MASK))
 484 #define INTRNO(infop)   ((infop)->ivect_no & ~MOD_INTRVER_MASK)
 485
 486 struct intr_info0 {
 487         int     ivect_no;
 488         int     int_pri;
 489         int     itype;
 490 };
 491
 492 struct intr_info {
 493         int     ivect_no;
 494         int     int_pri;
 495         int     itype;
 496         int     int_cpu;
 497         int     int_mp;
 498 };
 499
 500 #endif  /* _SYS_SDI_H_ */