sys/cam/cam_sim.h

   1 /*-
   2  * Data structures and definitions for SCSI Interface Modules (SIMs).
   3  *
   4  * SPDX-License-Identifier: BSD-2-Clause
   5  *
   6  * Copyright (c) 1997 Justin T. Gibbs.
   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, immediately at the beginning of the file.
  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  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  22  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30
  31 #ifndef _CAM_CAM_SIM_H
  32 #define _CAM_CAM_SIM_H 1
  33
  34 #ifdef _KERNEL
  35
  36 /*
  37  * The sim driver creates a sim for each controller.  The sim device
  38  * queue is separately created in order to allow resource sharing between
  39  * sims.  For instance, a driver may create one sim for each channel of
  40  * a multi-channel controller and use the same queue for each channel.
  41  * In this way, the queue resources are shared across all the channels
  42  * of the multi-channel controller.
  43  */
  44
  45 struct cam_sim;
  46 struct cam_devq;
  47
  48 typedef void (*sim_action_func)(struct cam_sim *sim, union ccb *ccb);
  49 typedef void (*sim_poll_func)(struct cam_sim *sim);
  50
  51 struct cam_devq * cam_simq_alloc(uint32_t max_sim_transactions);
  52 void              cam_simq_free(struct cam_devq *devq);
  53
  54 struct cam_sim *  cam_sim_alloc(sim_action_func sim_action,
  55                                 sim_poll_func sim_poll,
  56                                 const char *sim_name,
  57                                 void *softc,
  58                                 uint32_t unit,
  59                                 struct mtx *mtx,
  60                                 int max_dev_transactions,
  61                                 int max_tagged_dev_transactions,
  62                                 struct cam_devq *queue);
  63 void              cam_sim_free(struct cam_sim *sim, int free_devq);
  64 void              cam_sim_hold(struct cam_sim *sim);
  65 void              cam_sim_release(struct cam_sim *sim);
  66
  67 /* Optional sim attributes may be set with these. */
  68 void    cam_sim_set_path(struct cam_sim *sim, uint32_t path_id);
  69
  70 /* Generically useful offsets into the sim private area */
  71 #define spriv_ptr0 sim_priv.entries[0].ptr
  72 #define spriv_ptr1 sim_priv.entries[1].ptr
  73 #define spriv_field0 sim_priv.entries[0].field
  74 #define spriv_field1 sim_priv.entries[1].field
  75
  76 /*
  77  * The sim driver should not access anything directly from this
  78  * structure.
  79  */
  80 struct cam_sim {
  81         sim_action_func         sim_action;
  82         sim_poll_func           sim_poll;
  83         const char              *sim_name;
  84         void                    *softc;
  85         struct mtx              *mtx;
  86         TAILQ_ENTRY(cam_sim)    links;
  87         uint32_t                path_id;/* The Boot device may set this to 0? */
  88         uint32_t                unit_number;
  89         uint32_t                bus_id;
  90         int                     max_tagged_dev_openings;
  91         int                     max_dev_openings;
  92         uint32_t                flags;
  93         struct cam_devq         *devq;  /* Device Queue to use for this SIM */
  94         int                     refcount; /* References to the SIM. */
  95 };
  96
  97 static __inline uint32_t
  98 cam_sim_path(const struct cam_sim *sim)
  99 {
 100         return (sim->path_id);
 101 }
 102
 103 static __inline const char *
 104 cam_sim_name(const struct cam_sim *sim)
 105 {
 106         return (sim->sim_name);
 107 }
 108
 109 static __inline void *
 110 cam_sim_softc(const struct cam_sim *sim)
 111 {
 112         return (sim->softc);
 113 }
 114
 115 static __inline uint32_t
 116 cam_sim_unit(const struct cam_sim *sim)
 117 {
 118         return (sim->unit_number);
 119 }
 120
 121 static __inline uint32_t
 122 cam_sim_bus(const struct cam_sim *sim)
 123 {
 124         return (sim->bus_id);
 125 }
 126
 127 static __inline bool
 128 cam_sim_pollable(const struct cam_sim *sim)
 129 {
 130         return (sim->sim_poll != NULL);
 131 }
 132
 133 #endif /* _KERNEL */
 134 #endif /* _CAM_CAM_SIM_H */