ips.h

Version: - FREEBSD - FREEBSD-13-STABLE - FREEBSD-13-0 - FREEBSD-12-STABLE - FREEBSD-12-0 - FREEBSD-11-STABLE - FREEBSD-11-0 - FREEBSD-10-STABLE - FREEBSD-10-0 - FREEBSD-9-STABLE - FREEBSD-9-0 - FREEBSD-8-STABLE - FREEBSD-8-0 - FREEBSD-7-STABLE - FREEBSD-7-0 - FREEBSD-6-STABLE - FREEBSD-6-0 - FREEBSD-5-STABLE - FREEBSD-5-0 - FREEBSD-4-STABLE - FREEBSD-3-STABLE - FREEBSD22 - l41 - OPENBSD - linux-2.6 - MK84 - PLAN9 - xnu-8792
SearchContext: - none - 3 - 10
    1 /*-
    2  * Copyright (c) 2002 Adaptec Inc.
    3  * All rights reserved.
    4  *
    5  * Written by: David Jeffery
    6  *
    7  * Redistribution and use in source and binary forms, with or without
    8  * modification, are permitted provided that the following conditions
    9  * are met:
   10  * 1. Redistributions of source code must retain the above copyright
   11  *    notice, this list of conditions and the following disclaimer.
   12  * 2. Redistributions in binary form must reproduce the above copyright
   13  *    notice, this list of conditions and the following disclaimer in the
   14  *    documentation and/or other materials provided with the distribution.
   15  *
   16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
   17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
   20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   26  * SUCH DAMAGE.
   27  *
   28  * $FreeBSD$
   29  */
   30 
   31 
   32 #include <sys/param.h>
   33 #include <sys/systm.h>
   34 #include <sys/kernel.h>
   35 #include <sys/module.h>
   36 #include <sys/bus.h>
   37 #include <sys/conf.h>
   38 #include <sys/types.h>
   39 #include <sys/queue.h>
   40 #include <sys/buf.h>
   41 #include <sys/malloc.h>
   42 #include <sys/time.h>
   43 
   44 #include <machine/bus_memio.h>
   45 #include <machine/bus.h>
   46 #include <sys/rman.h>
   47 #include <machine/resource.h>
   48 
   49 #include <pci/pcireg.h>
   50 #include <pci/pcivar.h>
   51 
   52 MALLOC_DECLARE(M_IPSBUF);
   53 
   54 /*
   55  *   IPS CONSTANTS
   56  */
   57 #define IPS_VENDOR_ID                   0x1014
   58 #define IPS_VENDOR_ID_ADAPTEC           0x9005
   59 #define IPS_MORPHEUS_DEVICE_ID          0x01BD
   60 #define IPS_COPPERHEAD_DEVICE_ID        0x002E
   61 #define IPS_MARCO_DEVICE_ID             0x0250
   62 #define IPS_CSL                         0xff
   63 #define IPS_POCL                        0x30
   64 
   65 /* amounts of memory to allocate for certain commands */
   66 #define IPS_ADAPTER_INFO_LEN            (sizeof(ips_adapter_info_t))
   67 #define IPS_DRIVE_INFO_LEN              (sizeof(ips_drive_info_t)) 
   68 #define IPS_COMMAND_LEN                 24
   69 #define IPS_MAX_SG_LEN                  (sizeof(ips_sg_element_t) * IPS_MAX_SG_ELEMENTS)
   70 #define IPS_NVRAM_PAGE_SIZE             128
   71 /* various flags */
   72 #define IPS_NOWAIT_FLAG                 1
   73 
   74 /* states for the card to be in */
   75 #define IPS_DEV_OPEN                    0x01
   76 #define IPS_TIMEOUT                     0x02 /* command time out, need reset */
   77 #define IPS_OFFLINE                     0x04 /* can't reset card/card failure */
   78 
   79 /* max number of commands set to something low for now */
   80 #define IPS_MAX_CMD_NUM                 128     
   81 #define IPS_MAX_NUM_DRIVES              8
   82 #define IPS_MAX_SG_ELEMENTS             32
   83 #define IPS_MAX_IOBUF_SIZE              (64 * 1024)
   84 #define IPS_BLKSIZE                     512
   85 
   86 /* logical drive states */
   87 
   88 #define IPS_LD_OFFLINE                  0x02
   89 #define IPS_LD_OKAY                     0x03
   90 #define IPS_LD_DEGRADED                 0x04
   91 #define IPS_LD_FREE                     0x00
   92 #define IPS_LD_SYS                      0x06
   93 #define IPS_LD_CRS                      0x24
   94 
   95 /* register offsets */
   96 #define MORPHEUS_REG_OMR0               0x0018 /* Outbound Msg. Reg. 0 */
   97 #define MORPHEUS_REG_OMR1               0x001C /* Outbound Msg. Reg. 1 */
   98 #define MORPHEUS_REG_IDR                0x0020 /* Inbound Doorbell Reg. */
   99 #define MORPHEUS_REG_IISR               0x0024 /* Inbound IRQ Status Reg. */
  100 #define MORPHEUS_REG_IIMR               0x0028 /* Inbound IRQ Mask Reg. */
  101 #define MORPHEUS_REG_OISR               0x0030 /* Outbound IRQ Status Reg. */
  102 #define MORPHEUS_REG_OIMR               0x0034 /* Outbound IRQ Status Reg. */
  103 #define MORPHEUS_REG_IQPR               0x0040 /* Inbound Queue Port Reg. */
  104 #define MORPHEUS_REG_OQPR               0x0044 /* Outbound Queue Port Reg. */
  105 
  106 #define COPPER_REG_SCPR                 0x05    /* Subsystem Ctrl. Port Reg. */
  107 #define COPPER_REG_ISPR                 0x06    /* IRQ Status Port Reg. */
  108 #define COPPER_REG_CBSP                 0x07    /* ? Reg. */
  109 #define COPPER_REG_HISR                 0x08    /* Host IRQ Status Reg.    */
  110 #define COPPER_REG_CCSAR                0x10    /* Cmd. Channel Sys Addr Reg.*/
  111 #define COPPER_REG_CCCR                 0x14    /* Cmd. Channel Ctrl. Reg. */
  112 #define COPPER_REG_SQHR                 0x20    /* Status Queue Head Reg.  */
  113 #define COPPER_REG_SQTR                 0x24    /* Status Queue Tail Reg.  */
  114 #define COPPER_REG_SQER                 0x28    /* Status Queue End Reg.   */
  115 #define COPPER_REG_SQSR                 0x2C    /* Status Queue Start Reg. */
  116 
  117 /* bit definitions */
  118 #define MORPHEUS_BIT_POST1              0x01
  119 #define MORPHEUS_BIT_POST2              0x02
  120 #define MORPHEUS_BIT_CMD_IRQ            0x08
  121 
  122 #define COPPER_CMD_START                0x101A
  123 #define COPPER_SEM_BIT                  0x08
  124 #define COPPER_EI_BIT                   0x80
  125 #define COPPER_EBM_BIT                  0x02
  126 #define COPPER_RESET_BIT                0x80
  127 #define COPPER_GHI_BIT                  0x04
  128 #define COPPER_SCE_BIT                  0x01
  129 #define COPPER_OP_BIT                   0x01
  130 #define COPPER_ILE_BIT                  0x10
  131 
  132 /* status defines */
  133 #define IPS_POST1_OK                    0x8000
  134 #define IPS_POST2_OK                    0x000f
  135 
  136 /* command op codes */
  137 #define IPS_READ_CMD                    0x02
  138 #define IPS_WRITE_CMD                   0x03
  139 #define IPS_ADAPTER_INFO_CMD            0x05
  140 #define IPS_CACHE_FLUSH_CMD             0x0A
  141 #define IPS_REBUILD_STATUS_CMD          0x0C
  142 #define IPS_ERROR_TABLE_CMD             0x17
  143 #define IPS_DRIVE_INFO_CMD              0x19
  144 #define IPS_SUBSYS_PARAM_CMD            0x40
  145 #define IPS_CONFIG_SYNC_CMD             0x58
  146 #define IPS_SG_READ_CMD                 0x82
  147 #define IPS_SG_WRITE_CMD                0x83
  148 #define IPS_RW_NVRAM_CMD                0xBC
  149 #define IPS_FFDC_CMD                    0xD7
  150 
  151 /* error information returned by the adapter */
  152 #define IPS_MIN_ERROR                   0x02
  153 #define IPS_ERROR_STATUS                0x13000200 /* ahh, magic numbers */
  154 
  155 #define IPS_OS_FREEBSD                  8
  156 #define IPS_VERSION_MAJOR               "0.90"
  157 #define IPS_VERSION_MINOR               ".10"
  158 
  159 /* Adapter Types */
  160 #define IPS_ADAPTER_COPPERHEAD          0x01
  161 #define IPS_ADAPTER_COPPERHEAD2         0x02
  162 #define IPS_ADAPTER_COPPERHEADOB1       0x03
  163 #define IPS_ADAPTER_COPPERHEADOB2       0x04
  164 #define IPS_ADAPTER_CLARINET            0x05
  165 #define IPS_ADAPTER_CLARINETLITE        0x06
  166 #define IPS_ADAPTER_TROMBONE            0x07
  167 #define IPS_ADAPTER_MORPHEUS            0x08
  168 #define IPS_ADAPTER_MORPHEUSLITE        0x09
  169 #define IPS_ADAPTER_NEO                 0x0A
  170 #define IPS_ADAPTER_NEOLITE             0x0B
  171 #define IPS_ADAPTER_SARASOTA2           0x0C
  172 #define IPS_ADAPTER_SARASOTA1           0x0D
  173 #define IPS_ADAPTER_MARCO               0x0E
  174 #define IPS_ADAPTER_SEBRING             0x0F
  175 #define IPS_ADAPTER_MAX_T               IPS_ADAPTER_SEBRING
  176 
  177 /* values for ffdc_settime (from gmtime) */
  178 #define IPS_SECSPERMIN      60
  179 #define IPS_MINSPERHOUR     60
  180 #define IPS_HOURSPERDAY     24
  181 #define IPS_DAYSPERWEEK     7
  182 #define IPS_DAYSPERNYEAR    365
  183 #define IPS_DAYSPERLYEAR    366
  184 #define IPS_SECSPERHOUR     (IPS_SECSPERMIN * IPS_MINSPERHOUR)
  185 #define IPS_SECSPERDAY      ((long) IPS_SECSPERHOUR * IPS_HOURSPERDAY)
  186 #define IPS_MONSPERYEAR     12
  187 #define IPS_EPOCH_YEAR      1970
  188 #define IPS_LEAPS_THRU_END_OF(y)    ((y) / 4 - (y) / 100 + (y) / 400)
  189 #define ips_isleap(y) (((y) % 4) == 0 && (((y) % 100) != 0 || ((y) % 400) == 0))
  190 
  191 /*
  192  *  IPS MACROS
  193  */
  194 
  195 #define ips_read_1(sc,offset)           bus_space_read_1(sc->bustag, sc->bushandle, offset)
  196 #define ips_read_2(sc,offset)           bus_space_read_2(sc->bustag, sc->bushandle, offset)
  197 #define ips_read_4(sc,offset)           bus_space_read_4(sc->bustag, sc->bushandle, offset)
  198 
  199 #define ips_write_1(sc,offset,value)    bus_space_write_1(sc->bustag, sc->bushandle, offset, value)
  200 #define ips_write_2(sc,offset,value)    bus_space_write_2(sc->bustag, sc->bushandle, offset, value)
  201 #define ips_write_4(sc,offset,value)    bus_space_write_4(sc->bustag, sc->bushandle, offset, value)
  202 
  203 /* this is ugly.  It zeros the end elements in an ips_command_t struct starting with the status element */
  204 #define clear_ips_command(command)      bzero(&((command)->status), (unsigned long)(&(command)[1])-(unsigned long)&((command)->status))
  205 
  206 #define ips_read_request(iobuf)         ((iobuf)->b_flags & B_READ)
  207 
  208 #define COMMAND_ERROR(status)           (((status)->fields.basic_status & 0x0f) >= IPS_MIN_ERROR)
  209 
  210 #ifndef IPS_DEBUG
  211 #define DEVICE_PRINTF(x...)
  212 #define PRINTF(x...)
  213 #else
  214 #define DEVICE_PRINTF(level,x...)       if(IPS_DEBUG >= level)device_printf(x)
  215 #define PRINTF(level,x...)              if(IPS_DEBUG >= level)printf(x)
  216 #endif
  217 /*
  218  *   IPS STRUCTS
  219  */
  220 
  221 struct ips_softc;
  222 
  223 typedef struct{
  224         u_int8_t        command;
  225         u_int8_t        id;
  226         u_int8_t        drivenum;
  227         u_int8_t        reserve2;
  228         u_int32_t       lba;
  229         u_int32_t       buffaddr;
  230         u_int32_t       reserve3;
  231 } __attribute__ ((packed)) ips_generic_cmd;
  232 
  233 typedef struct{
  234         u_int8_t        command;
  235         u_int8_t        id;
  236         u_int8_t        drivenum;
  237         u_int8_t        segnum;
  238         u_int32_t       lba;
  239         u_int32_t       buffaddr;
  240         u_int16_t       length;
  241         u_int16_t       reserve1;
  242 } __attribute__ ((packed)) ips_io_cmd;
  243 
  244 typedef struct{
  245         u_int8_t        command;
  246         u_int8_t        id;
  247         u_int8_t        pagenum;
  248         u_int8_t        rw;
  249         u_int32_t       reserve1;
  250         u_int32_t       buffaddr;
  251         u_int32_t       reserve3;
  252 } __attribute__ ((packed)) ips_rw_nvram_cmd;
  253 
  254 typedef struct{
  255         u_int8_t        command;
  256         u_int8_t        id;
  257         u_int8_t        drivenum;
  258         u_int8_t        reserve1;
  259         u_int32_t       reserve2;
  260         u_int32_t       buffaddr;
  261         u_int32_t       reserve3;
  262 } __attribute__ ((packed)) ips_drive_cmd;
  263 
  264 typedef struct{
  265         u_int8_t        command;
  266         u_int8_t        id;
  267         u_int8_t        reserve1;
  268         u_int8_t        commandtype;
  269         u_int32_t       reserve2;
  270         u_int32_t       buffaddr;
  271         u_int32_t       reserve3;
  272 } __attribute__((packed)) ips_adapter_info_cmd;
  273 
  274 typedef struct{
  275         u_int8_t        command;
  276         u_int8_t        id;
  277         u_int8_t        reset_count;
  278         u_int8_t        reset_type;
  279         u_int8_t        second;
  280         u_int8_t        minute;
  281         u_int8_t        hour;
  282         u_int8_t        day;
  283         u_int8_t        reserve1[4];
  284         u_int8_t        month;
  285         u_int8_t        yearH;
  286         u_int8_t        yearL;
  287         u_int8_t        reserve2;
  288 } __attribute__((packed)) ips_adapter_ffdc_cmd;
  289 
  290 typedef union{
  291         ips_generic_cmd         generic_cmd;
  292         ips_drive_cmd           drive_cmd;
  293         ips_adapter_info_cmd    adapter_info_cmd;
  294 } ips_cmd_buff_t;
  295 
  296 typedef struct {
  297    u_int32_t  signature;
  298    u_int8_t   reserved;
  299    u_int8_t   adapter_slot;
  300    u_int16_t  adapter_type;
  301    u_int8_t   bios_high[4];
  302    u_int8_t   bios_low[4];
  303    u_int16_t  reserve2;
  304    u_int8_t   reserve3;
  305    u_int8_t   operating_system;
  306    u_int8_t   driver_high[4];
  307    u_int8_t   driver_low[4];
  308    u_int8_t   reserve4[100];
  309 }__attribute__((packed)) ips_nvram_page5;
  310 
  311 typedef struct{
  312         u_int32_t       addr;
  313         u_int32_t       len;
  314 } ips_sg_element_t;
  315 
  316 typedef struct{
  317         u_int8_t        drivenum;
  318         u_int8_t        merge_id;
  319         u_int8_t        raid_lvl;
  320         u_int8_t        state;
  321         u_int32_t       sector_count;
  322 } __attribute__((packed)) ips_drive_t;
  323 
  324 typedef struct{
  325         u_int8_t        drivecount;
  326         u_int8_t        reserve1;
  327         u_int16_t       reserve2;
  328         ips_drive_t drives[IPS_MAX_NUM_DRIVES];
  329 }__attribute__((packed)) ips_drive_info_t;
  330 
  331 typedef struct{
  332         u_int8_t        drivecount;
  333         u_int8_t        miscflags;
  334         u_int8_t        SLTflags;
  335         u_int8_t        BSTflags;
  336         u_int8_t        pwr_chg_count;
  337         u_int8_t        wrong_addr_count;
  338         u_int8_t        unident_count;
  339         u_int8_t        nvram_dev_chg_count;
  340         u_int8_t        codeblock_version[8];
  341         u_int8_t        bootblock_version[8];
  342         u_int32_t       drive_sector_count[IPS_MAX_NUM_DRIVES];
  343         u_int8_t        max_concurrent_cmds;
  344         u_int8_t        max_phys_devices;
  345         u_int16_t       flash_prog_count;
  346         u_int8_t        defunct_disks;
  347         u_int8_t        rebuildflags;
  348         u_int8_t        offline_drivecount;
  349         u_int8_t        critical_drivecount;
  350         u_int16_t       config_update_count;
  351         u_int8_t        blockedflags;
  352         u_int8_t        psdn_error;
  353         u_int16_t       addr_dead_disk[4*16];/* ugly, max # channels * max # scsi devices per channel */
  354 }__attribute__((packed)) ips_adapter_info_t;
  355 
  356 typedef struct {
  357         u_int32_t       status[IPS_MAX_CMD_NUM];
  358         u_int32_t       base_phys_addr;
  359         int             nextstatus;
  360         bus_dma_tag_t   dmatag;
  361         bus_dmamap_t    dmamap;
  362 } ips_copper_queue_t;
  363 
  364 typedef union {
  365    struct {
  366       u_int8_t  reserved;
  367       u_int8_t  command_id;
  368       u_int8_t  basic_status;
  369       u_int8_t  extended_status;
  370    } fields;
  371    volatile u_int32_t    value;
  372 } ips_cmd_status_t;
  373 
  374 /* used to keep track of current commands to the card */
  375 typedef struct ips_command{
  376         u_int8_t                command_number;
  377         u_int8_t                id;
  378         u_int8_t                timeout;
  379         struct ips_softc *      sc;
  380         bus_dmamap_t            command_dmamap;
  381         void *                  command_buffer;
  382         u_int32_t               command_phys_addr;/*WARNING! must be changed if 64bit addressing ever used*/    
  383         ips_cmd_status_t        status;
  384         SLIST_ENTRY(ips_command)        next;
  385         bus_dma_tag_t           data_dmatag;
  386         bus_dmamap_t            data_dmamap;
  387         void *                  data_buffer;
  388         void *                  arg;
  389         void                    (* callback)(struct ips_command *command);
  390 }ips_command_t;
  391 
  392 typedef struct ips_wait_list{
  393         STAILQ_ENTRY(ips_wait_list) next;
  394         void                    *data;
  395         int                     (* callback)(ips_command_t *command);
  396 }ips_wait_list_t;
  397 
  398 typedef struct ips_softc{
  399         struct resource *       iores;
  400         struct resource *       irqres;
  401         struct intr_config_hook ips_ich;
  402         int                     configured;
  403         int                     state;
  404         int                     iotype;
  405         int                     rid;
  406         int                     irqrid;
  407         void *                  irqcookie;
  408         bus_space_tag_t         bustag;
  409         bus_space_handle_t      bushandle;
  410         bus_dma_tag_t           adapter_dmatag;
  411         bus_dma_tag_t           command_dmatag;
  412         bus_dma_tag_t           sg_dmatag;
  413         device_t                dev;
  414         dev_t                   device_file;
  415         struct callout_handle   timer;
  416         u_int16_t               adapter_type;
  417         ips_adapter_info_t      adapter_info;
  418         device_t                diskdev[IPS_MAX_NUM_DRIVES];
  419         ips_drive_t             drives[IPS_MAX_NUM_DRIVES];
  420         u_int8_t                drivecount;
  421         u_int16_t               ffdc_resetcount;
  422         struct timeval          ffdc_resettime;
  423         u_int8_t                next_drive;
  424         u_int8_t                max_cmds;
  425         volatile u_int8_t       used_commands;
  426         ips_command_t           commandarray[IPS_MAX_CMD_NUM];
  427         SLIST_HEAD(command_list, ips_command) free_cmd_list;
  428         STAILQ_HEAD(command_wait_list,ips_wait_list)  cmd_wait_list;
  429         int                     (* ips_adapter_reinit)(struct ips_softc *sc, 
  430                                                        int force);
  431         void                    (* ips_adapter_intr)(void *sc);
  432         void                    (* ips_issue_cmd)(ips_command_t *command);
  433         ips_copper_queue_t *    copper_queue;
  434         struct buf_queue_head   queue;
  435 
  436 }ips_softc_t;
  437 
  438 /* function defines from ips_ioctl.c */
  439 extern int ips_ioctl_request(ips_softc_t *sc, u_long ioctl_cmd, caddr_t addr, 
  440                                 int32_t flags);
  441 /* function defines from ips_disk.c */
  442 extern void ipsd_finish(struct buf *iobuf);
  443 
  444 /* function defines from ips_commands.c */
  445 extern int ips_flush_cache(ips_softc_t *sc);
  446 extern void ips_start_io_request(ips_softc_t *sc);
  447 extern int ips_get_drive_info(ips_softc_t *sc);
  448 extern int ips_get_adapter_info(ips_softc_t *sc);
  449 extern int ips_ffdc_reset(ips_softc_t *sc);
  450 extern int ips_update_nvram(ips_softc_t *sc); 
  451 extern int ips_clear_adapter(ips_softc_t *sc);
  452 
  453 /* function defines from ips.c */
  454 extern int ips_get_free_cmd(ips_softc_t *sc, int (*callback)(ips_command_t *), 
  455                                 void *data, unsigned long flags);
  456 extern void ips_insert_free_cmd(ips_softc_t *sc, ips_command_t *command);
  457 extern int ips_adapter_init(ips_softc_t *sc);
  458 extern int ips_morpheus_reinit(ips_softc_t *sc, int force);
  459 extern int ips_adapter_free(ips_softc_t *sc);
  460 extern void ips_morpheus_intr(void *sc);
  461 extern void ips_issue_morpheus_cmd(ips_command_t *command);
  462 extern int ips_copperhead_reinit(ips_softc_t *sc, int force);
  463 extern void ips_copperhead_intr(void *sc);
  464 extern void ips_issue_copperhead_cmd(ips_command_t *command);
  465
Cache object: a13dcb1b2fd68c5bed232b4320138438
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]
This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.
FreeBSD/Linux Kernel Cross Reference sys/dev/ips/ips.h

FreeBSD/Linux Kernel Cross Reference
sys/dev/ips/ips.h
