The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/dev/aic7xxx/aic_osm_lib.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  * FreeBSD platform specific, shared driver option settings, data structures,
    3  * function declarations and includes.
    4  *
    5  * Copyright (c) 1994-2001 Justin T. Gibbs.
    6  * Copyright (c) 2001-2003 Adaptec Inc.
    7  * All rights reserved.
    8  *
    9  * Redistribution and use in source and binary forms, with or without
   10  * modification, are permitted provided that the following conditions
   11  * are met:
   12  * 1. Redistributions of source code must retain the above copyright
   13  *    notice, this list of conditions, and the following disclaimer,
   14  *    without modification.
   15  * 2. The name of the author may not be used to endorse or promote products
   16  *    derived from this software without specific prior written permission.
   17  *
   18  * Alternatively, this software may be distributed under the terms of the
   19  * GNU Public License ("GPL").
   20  *
   21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
   22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   24  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
   25  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   31  * SUCH DAMAGE.
   32  *
   33  * $Id: //depot/aic7xxx/freebsd/dev/aic7xxx/aic_osm_lib.h#5 $
   34  *
   35  * $FreeBSD: releng/6.2/sys/dev/aic7xxx/aic_osm_lib.h 139749 2005-01-06 01:43:34Z imp $
   36  */
   37 
   38 /******************************** OS Includes *********************************/
   39 #if __FreeBSD_version >= 500000
   40 #include <sys/mutex.h>
   41 #endif
   42 
   43 /*************************** Library Symbol Mapping ***************************/
   44 #define AIC_LIB_ENTRY_CONCAT(x, prefix) prefix ## x
   45 #define AIC_LIB_ENTRY_EXPAND(x, prefix) AIC_LIB_ENTRY_CONCAT(x, prefix)
   46 #define AIC_LIB_ENTRY(x)                AIC_LIB_ENTRY_EXPAND(x, AIC_LIB_PREFIX)
   47 #define AIC_CONST_ENTRY(x)              AIC_LIB_ENTRY_EXPAND(x,AIC_CONST_PREFIX)
   48 
   49 #define aic_softc                       AIC_LIB_ENTRY(_softc)
   50 #define aic_tailq                       AIC_LIB_ENTRY(_tailq)
   51 #define aic_transinfo                   AIC_LIB_ENTRY(_transinfo)
   52 #define aic_platform_data               AIC_LIB_ENTRY(_platform_data)
   53 #define aic_devinfo                     AIC_LIB_ENTRY(_devinfo)
   54 #define aic_lock                        AIC_LIB_ENTRY(_lock)
   55 #define aic_unlock                      AIC_LIB_ENTRY(_unlock)
   56 #define aic_callback_t                  AIC_LIB_ENTRY(_callback_t)
   57 #define aic_platform_freeze_devq        AIC_LIB_ENTRY(_platform_freeze_devq)
   58 #define aic_platform_abort_scbs         AIC_LIB_ENTRY(_platform_abort_scbs)
   59 #define aic_platform_timeout            AIC_LIB_ENTRY(_platform_timeout)
   60 #define aic_timeout                     AIC_LIB_ENTRY(_timeout)
   61 #define aic_set_recoveryscb             AIC_LIB_ENTRY(_set_recoveryscb)
   62 #define aic_spawn_recovery_thread       AIC_LIB_ENTRY(_spawn_recovery_thread)
   63 #define aic_wakeup_recovery_thread      AIC_LIB_ENTRY(_wakeup_recovery_thread)
   64 #define aic_terminate_recovery_thread \
   65         AIC_LIB_ENTRY(_terminate_recovery_thread)
   66 #define aic_recovery_thread             AIC_LIB_ENTRY(_recovery_thread)
   67 #define aic_recover_commands            AIC_LIB_ENTRY(_recover_commands)
   68 #define aic_calc_geometry               AIC_LIB_ENTRY(_calc_geometry)
   69 
   70 #define AIC_RESOURCE_SHORTAGE           AIC_CONST_ENTRY(_RESOURCE_SHORTAGE)
   71 #define AIC_SHUTDOWN_RECOVERY           AIC_CONST_ENTRY(_SHUTDOWN_RECOVERY)
   72 
   73 /********************************* Byte Order *********************************/
   74 #if __FreeBSD_version >= 500000
   75 #define aic_htobe16(x) htobe16(x)
   76 #define aic_htobe32(x) htobe32(x)
   77 #define aic_htobe64(x) htobe64(x)
   78 #define aic_htole16(x) htole16(x)
   79 #define aic_htole32(x) htole32(x)
   80 #define aic_htole64(x) htole64(x)
   81 
   82 #define aic_be16toh(x) be16toh(x)
   83 #define aic_be32toh(x) be32toh(x)
   84 #define aic_be64toh(x) be64toh(x)
   85 #define aic_le16toh(x) le16toh(x)
   86 #define aic_le32toh(x) le32toh(x)
   87 #define aic_le64toh(x) le64toh(x)
   88 #else
   89 #define aic_htobe16(x) (x)
   90 #define aic_htobe32(x) (x)
   91 #define aic_htobe64(x) (x)
   92 #define aic_htole16(x) (x)
   93 #define aic_htole32(x) (x)
   94 #define aic_htole64(x) (x)
   95 
   96 #define aic_be16toh(x) (x)
   97 #define aic_be32toh(x) (x)
   98 #define aic_be64toh(x) (x)
   99 #define aic_le16toh(x) (x)
  100 #define aic_le32toh(x) (x)
  101 #define aic_le64toh(x) (x)
  102 #endif
  103 
  104 /************************* Forward Declarations *******************************/
  105 typedef device_t aic_dev_softc_t;
  106 typedef union ccb *aic_io_ctx_t;
  107 struct aic_softc;
  108 struct scb;
  109 
  110 /*************************** Timer DataStructures *****************************/
  111 typedef struct callout aic_timer_t;
  112 
  113 /****************************** Error Recovery ********************************/
  114 void            aic_set_recoveryscb(struct aic_softc *aic, struct scb *scb);
  115 timeout_t       aic_platform_timeout;
  116 int             aic_spawn_recovery_thread(struct aic_softc *aic);
  117 void            aic_terminate_recovery_thread(struct aic_softc *aic);
  118 
  119 static __inline void    aic_wakeup_recovery_thread(struct aic_softc *aic);
  120 
  121 static __inline void
  122 aic_wakeup_recovery_thread(struct aic_softc *aic)
  123 {
  124         wakeup(aic);
  125 }
  126 
  127 /****************************** Kernel Threads ********************************/
  128 #if __FreeBSD_version > 500005
  129 #define aic_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
  130         kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
  131 #else
  132 #define aic_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
  133         kthread_create(func, farg, proc_ptr, fmtstr, arg)
  134 #endif
  135 
  136 /******************************* Bus Space/DMA ********************************/
  137 
  138 #if __FreeBSD_version >= 501102
  139 #define aic_dma_tag_create(aic, parent_tag, alignment, boundary,        \
  140                            lowaddr, highaddr, filter, filterarg,        \
  141                            maxsize, nsegments, maxsegsz, flags,         \
  142                            dma_tagp)                                    \
  143         bus_dma_tag_create(parent_tag, alignment, boundary,             \
  144                            lowaddr, highaddr, filter, filterarg,        \
  145                            maxsize, nsegments, maxsegsz, flags,         \
  146                            busdma_lock_mutex, &Giant,                   \
  147                            dma_tagp)
  148 #else
  149 #define aic_dma_tag_create(aic, parent_tag, alignment, boundary,        \
  150                            lowaddr, highaddr, filter, filterarg,        \
  151                            maxsize, nsegments, maxsegsz, flags,         \
  152                            dma_tagp)                                    \
  153         bus_dma_tag_create(parent_tag, alignment, boundary,             \
  154                            lowaddr, highaddr, filter, filterarg,        \
  155                            maxsize, nsegments, maxsegsz, flags,         \
  156                            dma_tagp)
  157 #endif
  158 
  159 #define aic_dma_tag_destroy(aic, tag)                                   \
  160         bus_dma_tag_destroy(tag)
  161 
  162 #define aic_dmamem_alloc(aic, dmat, vaddr, flags, mapp)                 \
  163         bus_dmamem_alloc(dmat, vaddr, flags, mapp)
  164 
  165 #define aic_dmamem_free(aic, dmat, vaddr, map)                          \
  166         bus_dmamem_free(dmat, vaddr, map)
  167 
  168 #define aic_dmamap_create(aic, tag, flags, mapp)                        \
  169         bus_dmamap_create(tag, flags, mapp)
  170 
  171 #define aic_dmamap_destroy(aic, tag, map)                               \
  172         bus_dmamap_destroy(tag, map)
  173 
  174 #define aic_dmamap_load(aic, dmat, map, addr, buflen, callback,         \
  175                         callback_arg, flags)                            \
  176         bus_dmamap_load(dmat, map, addr, buflen, callback, callback_arg, flags)
  177 
  178 #define aic_dmamap_unload(aic, tag, map)                                \
  179         bus_dmamap_unload(tag, map)
  180 
  181 /* XXX Need to update Bus DMA for partial map syncs */
  182 #define aic_dmamap_sync(aic, dma_tag, dmamap, offset, len, op)          \
  183         bus_dmamap_sync(dma_tag, dmamap, op)
  184 
  185 /***************************** Core Includes **********************************/
  186 #include AIC_CORE_INCLUDE
  187 
  188 /***************************** Timer Facilities *******************************/
  189 #if __FreeBSD_version >= 500000
  190 #define aic_timer_init(timer) callout_init(timer, /*mpsafe*/0)
  191 #else
  192 #define aic_timer_init callout_init
  193 #endif
  194 #define aic_timer_stop callout_stop
  195 
  196 static __inline void aic_timer_reset(aic_timer_t *, u_int,
  197                                      aic_callback_t *, void *);
  198 static __inline u_int aic_get_timeout(struct scb *);
  199 static __inline void aic_scb_timer_reset(struct scb *, u_int);
  200 
  201 static __inline void
  202 aic_timer_reset(aic_timer_t *timer, u_int msec, aic_callback_t *func, void *arg)
  203 {
  204         uint64_t time;
  205 
  206         time = msec;
  207         time *= hz;
  208         time /= 1000;
  209         callout_reset(timer, time, func, arg);
  210 }
  211 
  212 static __inline u_int
  213 aic_get_timeout(struct scb *scb)
  214 {
  215         return (scb->io_ctx->ccb_h.timeout);
  216 }
  217 
  218 static __inline void
  219 aic_scb_timer_reset(struct scb *scb, u_int msec)
  220 {
  221         uint64_t time;
  222 
  223         time = msec;
  224         time *= hz;
  225         time /= 1000;
  226         untimeout(aic_platform_timeout, (caddr_t)scb,
  227                   scb->io_ctx->ccb_h.timeout_ch);
  228         scb->io_ctx->ccb_h.timeout_ch =
  229             timeout(aic_platform_timeout, scb, time);
  230 }
  231 
  232 static __inline void
  233 aic_scb_timer_start(struct scb *scb)
  234 {
  235         
  236         if (AIC_SCB_DATA(scb->aic_softc)->recovery_scbs == 0
  237          && scb->io_ctx->ccb_h.timeout != CAM_TIME_INFINITY) {
  238                 uint64_t time;
  239 
  240                 time = scb->io_ctx->ccb_h.timeout;
  241                 time *= hz;
  242                 time /= 1000;
  243                 scb->io_ctx->ccb_h.timeout_ch =
  244                     timeout(aic_platform_timeout, scb, time);
  245         }
  246 }
  247 
  248 /************************** Transaction Operations ****************************/
  249 static __inline void aic_set_transaction_status(struct scb *, uint32_t);
  250 static __inline void aic_set_scsi_status(struct scb *, uint32_t);
  251 static __inline uint32_t aic_get_transaction_status(struct scb *);
  252 static __inline uint32_t aic_get_scsi_status(struct scb *);
  253 static __inline void aic_set_transaction_tag(struct scb *, int, u_int);
  254 static __inline u_long aic_get_transfer_length(struct scb *);
  255 static __inline int aic_get_transfer_dir(struct scb *);
  256 static __inline void aic_set_residual(struct scb *, u_long);
  257 static __inline void aic_set_sense_residual(struct scb *, u_long);
  258 static __inline u_long aic_get_residual(struct scb *);
  259 static __inline int aic_perform_autosense(struct scb *);
  260 static __inline uint32_t aic_get_sense_bufsize(struct aic_softc*, struct scb*);
  261 static __inline void aic_freeze_ccb(union ccb *ccb);
  262 static __inline void aic_freeze_scb(struct scb *scb);
  263 static __inline void aic_platform_freeze_devq(struct aic_softc *, struct scb *);
  264 static __inline int  aic_platform_abort_scbs(struct aic_softc *aic, int target,
  265                                              char channel, int lun, u_int tag,
  266                                              role_t role, uint32_t status);
  267 
  268 static __inline
  269 void aic_set_transaction_status(struct scb *scb, uint32_t status)
  270 {
  271         scb->io_ctx->ccb_h.status &= ~CAM_STATUS_MASK;
  272         scb->io_ctx->ccb_h.status |= status;
  273 }
  274 
  275 static __inline
  276 void aic_set_scsi_status(struct scb *scb, uint32_t status)
  277 {
  278         scb->io_ctx->csio.scsi_status = status;
  279 }
  280 
  281 static __inline
  282 uint32_t aic_get_transaction_status(struct scb *scb)
  283 {
  284         return (scb->io_ctx->ccb_h.status & CAM_STATUS_MASK);
  285 }
  286 
  287 static __inline
  288 uint32_t aic_get_scsi_status(struct scb *scb)
  289 {
  290         return (scb->io_ctx->csio.scsi_status);
  291 }
  292 
  293 static __inline
  294 void aic_set_transaction_tag(struct scb *scb, int enabled, u_int type)
  295 {
  296         scb->io_ctx->csio.tag_action = type;
  297         if (enabled)
  298                 scb->io_ctx->ccb_h.flags |= CAM_TAG_ACTION_VALID;
  299         else
  300                 scb->io_ctx->ccb_h.flags &= ~CAM_TAG_ACTION_VALID;
  301 }
  302 
  303 static __inline
  304 u_long aic_get_transfer_length(struct scb *scb)
  305 {
  306         return (scb->io_ctx->csio.dxfer_len);
  307 }
  308 
  309 static __inline
  310 int aic_get_transfer_dir(struct scb *scb)
  311 {
  312         return (scb->io_ctx->ccb_h.flags & CAM_DIR_MASK);
  313 }
  314 
  315 static __inline
  316 void aic_set_residual(struct scb *scb, u_long resid)
  317 {
  318         scb->io_ctx->csio.resid = resid;
  319 }
  320 
  321 static __inline
  322 void aic_set_sense_residual(struct scb *scb, u_long resid)
  323 {
  324         scb->io_ctx->csio.sense_resid = resid;
  325 }
  326 
  327 static __inline
  328 u_long aic_get_residual(struct scb *scb)
  329 {
  330         return (scb->io_ctx->csio.resid);
  331 }
  332 
  333 static __inline
  334 int aic_perform_autosense(struct scb *scb)
  335 {
  336         return (!(scb->io_ctx->ccb_h.flags & CAM_DIS_AUTOSENSE));
  337 }
  338 
  339 static __inline uint32_t
  340 aic_get_sense_bufsize(struct aic_softc *aic, struct scb *scb)
  341 {
  342         return (sizeof(struct scsi_sense_data));
  343 }
  344 
  345 static __inline void
  346 aic_freeze_ccb(union ccb *ccb)
  347 {
  348         if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
  349                 ccb->ccb_h.status |= CAM_DEV_QFRZN;
  350                 xpt_freeze_devq(ccb->ccb_h.path, /*count*/1);
  351         }
  352 }
  353 
  354 static __inline void
  355 aic_freeze_scb(struct scb *scb)
  356 {
  357         aic_freeze_ccb(scb->io_ctx);
  358 }
  359 
  360 static __inline void
  361 aic_platform_freeze_devq(struct aic_softc *aic, struct scb *scb)
  362 {
  363         /* Nothing to do here for FreeBSD */
  364 }
  365 
  366 static __inline int
  367 aic_platform_abort_scbs(struct aic_softc *aic, int target,
  368                         char channel, int lun, u_int tag,
  369                         role_t role, uint32_t status)
  370 {
  371         /* Nothing to do here for FreeBSD */
  372         return (0);
  373 }
  374 
  375 static __inline void
  376 aic_platform_scb_free(struct aic_softc *aic, struct scb *scb)
  377 {
  378         /* What do we do to generically handle driver resource shortages??? */
  379         if ((aic->flags & AIC_RESOURCE_SHORTAGE) != 0
  380          && scb->io_ctx != NULL
  381          && (scb->io_ctx->ccb_h.status & CAM_RELEASE_SIMQ) == 0) {
  382                 scb->io_ctx->ccb_h.status |= CAM_RELEASE_SIMQ;
  383                 aic->flags &= ~AIC_RESOURCE_SHORTAGE;
  384         }
  385         scb->io_ctx = NULL;
  386 }
  387 
  388 /*************************** CAM CCB Operations *******************************/
  389 void aic_calc_geometry(struct ccb_calc_geometry *ccg, int extended);
  390 
  391 /****************************** OS Primitives *********************************/
  392 #define aic_delay DELAY
  393 
  394 /********************************** PCI ***************************************/
  395 #ifdef AIC_PCI_CONFIG
  396 static __inline uint32_t aic_pci_read_config(aic_dev_softc_t pci,
  397                                              int reg, int width);
  398 static __inline void     aic_pci_write_config(aic_dev_softc_t pci,
  399                                               int reg, uint32_t value,
  400                                               int width);
  401 static __inline int      aic_get_pci_function(aic_dev_softc_t);
  402 static __inline int      aic_get_pci_slot(aic_dev_softc_t);
  403 static __inline int      aic_get_pci_bus(aic_dev_softc_t);
  404 
  405 
  406 static __inline uint32_t
  407 aic_pci_read_config(aic_dev_softc_t pci, int reg, int width)
  408 {
  409         return (pci_read_config(pci, reg, width));
  410 }
  411 
  412 static __inline void
  413 aic_pci_write_config(aic_dev_softc_t pci, int reg, uint32_t value, int width)
  414 {
  415         pci_write_config(pci, reg, value, width);
  416 }
  417 
  418 static __inline int
  419 aic_get_pci_function(aic_dev_softc_t pci)
  420 {
  421         return (pci_get_function(pci));
  422 }
  423 
  424 static __inline int
  425 aic_get_pci_slot(aic_dev_softc_t pci)
  426 {
  427         return (pci_get_slot(pci));
  428 }
  429 
  430 static __inline int
  431 aic_get_pci_bus(aic_dev_softc_t pci)
  432 {
  433         return (pci_get_bus(pci));
  434 }
  435 
  436 typedef enum
  437 {
  438         AIC_POWER_STATE_D0 = PCI_POWERSTATE_D0,
  439         AIC_POWER_STATE_D1 = PCI_POWERSTATE_D1,
  440         AIC_POWER_STATE_D2 = PCI_POWERSTATE_D2,
  441         AIC_POWER_STATE_D3 = PCI_POWERSTATE_D3
  442 } aic_power_state;
  443 
  444 static __inline int aic_power_state_change(struct aic_softc *aic,
  445                                            aic_power_state new_state);
  446 
  447 static __inline int
  448 aic_power_state_change(struct aic_softc *aic, aic_power_state new_state)
  449 {
  450         return (pci_set_powerstate(aic->dev_softc, new_state));
  451 }
  452 #endif

Cache object: b8f6ec5896d138939152f890dc0fad03

[ 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.