cam_periph.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  * Data structures and definitions for CAM peripheral ("type") drivers.
    3  *
    4  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
    5  *
    6  * Copyright (c) 1997, 1998 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  * $FreeBSD: releng/12.0/sys/cam/cam_periph.h 330935 2018-03-14 17:53:37Z imp $
   31  */
   32 
   33 #ifndef _CAM_CAM_PERIPH_H
   34 #define _CAM_CAM_PERIPH_H 1
   35 
   36 #include <sys/queue.h>
   37 #include <cam/cam_sim.h>
   38 
   39 #ifdef _KERNEL
   40 #include <sys/sysctl.h>
   41 #include <sys/taskqueue.h>
   42 
   43 #include <cam/cam_xpt.h>
   44 
   45 struct devstat;
   46 
   47 extern struct cam_periph *xpt_periph;
   48 
   49 extern struct periph_driver **periph_drivers;
   50 void periphdriver_register(void *);
   51 int periphdriver_unregister(void *);
   52 void periphdriver_init(int level);
   53 
   54 #include <sys/module.h>
   55 #define PERIPHDRIVER_DECLARE(name, driver) \
   56         static int name ## _modevent(module_t mod, int type, void *data) \
   57         { \
   58                 switch (type) { \
   59                 case MOD_LOAD: \
   60                         periphdriver_register(data); \
   61                         break; \
   62                 case MOD_UNLOAD: \
   63                         return (periphdriver_unregister(data)); \
   64                 default: \
   65                         return EOPNOTSUPP; \
   66                 } \
   67                 return 0; \
   68         } \
   69         static moduledata_t name ## _mod = { \
   70                 #name, \
   71                 name ## _modevent, \
   72                 (void *)&driver \
   73         }; \
   74         DECLARE_MODULE(name, name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \
   75         MODULE_DEPEND(name, cam, 1, 1, 1)
   76 
   77 /*
   78  * Callback informing the peripheral driver it can perform it's
   79  * initialization since the XPT is now fully initialized.
   80  */
   81 typedef void (periph_init_t)(void);
   82 
   83 /*
   84  * Callback requesting the peripheral driver to remove its instances
   85  * and shutdown, if possible.
   86  */
   87 typedef int (periph_deinit_t)(void);
   88 
   89 struct periph_driver {
   90         periph_init_t           *init;
   91         char                    *driver_name;
   92         TAILQ_HEAD(,cam_periph)  units;
   93         u_int                    generation;
   94         u_int                    flags;
   95 #define CAM_PERIPH_DRV_EARLY            0x01
   96         periph_deinit_t         *deinit;
   97 };
   98 
   99 typedef enum {
  100         CAM_PERIPH_BIO
  101 } cam_periph_type;
  102 
  103 /* Generically useful offsets into the peripheral private area */
  104 #define ppriv_ptr0 periph_priv.entries[0].ptr
  105 #define ppriv_ptr1 periph_priv.entries[1].ptr
  106 #define ppriv_field0 periph_priv.entries[0].field
  107 #define ppriv_field1 periph_priv.entries[1].field
  108 
  109 typedef void            periph_start_t (struct cam_periph *periph,
  110                                         union ccb *start_ccb);
  111 typedef cam_status      periph_ctor_t (struct cam_periph *periph,
  112                                        void *arg);
  113 typedef void            periph_oninv_t (struct cam_periph *periph);
  114 typedef void            periph_dtor_t (struct cam_periph *periph);
  115 struct cam_periph {
  116         periph_start_t          *periph_start;
  117         periph_oninv_t          *periph_oninval;
  118         periph_dtor_t           *periph_dtor;
  119         char                    *periph_name;
  120         struct cam_path         *path;  /* Compiled path to device */
  121         void                    *softc;
  122         struct cam_sim          *sim;
  123         u_int32_t                unit_number;
  124         cam_periph_type          type;
  125         u_int32_t                flags;
  126 #define CAM_PERIPH_RUNNING              0x01
  127 #define CAM_PERIPH_LOCKED               0x02
  128 #define CAM_PERIPH_LOCK_WANTED          0x04
  129 #define CAM_PERIPH_INVALID              0x08
  130 #define CAM_PERIPH_NEW_DEV_FOUND        0x10
  131 #define CAM_PERIPH_RECOVERY_INPROG      0x20
  132 #define CAM_PERIPH_RUN_TASK             0x40
  133 #define CAM_PERIPH_FREE                 0x80
  134 #define CAM_PERIPH_ANNOUNCED            0x100
  135         uint32_t                 scheduled_priority;
  136         uint32_t                 immediate_priority;
  137         int                      periph_allocating;
  138         int                      periph_allocated;
  139         u_int32_t                refcount;
  140         SLIST_HEAD(, ccb_hdr)    ccb_list;      /* For "immediate" requests */
  141         SLIST_ENTRY(cam_periph)  periph_links;
  142         TAILQ_ENTRY(cam_periph)  unit_links;
  143         ac_callback_t           *deferred_callback; 
  144         ac_code                  deferred_ac;
  145         struct task              periph_run_task;
  146 };
  147 
  148 #define CAM_PERIPH_MAXMAPS      2
  149 
  150 struct cam_periph_map_info {
  151         int             num_bufs_used;
  152         struct buf      *bp[CAM_PERIPH_MAXMAPS];
  153 };
  154 
  155 cam_status cam_periph_alloc(periph_ctor_t *periph_ctor,
  156                             periph_oninv_t *periph_oninvalidate,
  157                             periph_dtor_t *periph_dtor,
  158                             periph_start_t *periph_start,
  159                             char *name, cam_periph_type type, struct cam_path *,
  160                             ac_callback_t *, ac_code, void *arg);
  161 struct cam_periph *cam_periph_find(struct cam_path *path, char *name);
  162 int             cam_periph_list(struct cam_path *, struct sbuf *);
  163 int             cam_periph_acquire(struct cam_periph *periph);
  164 void            cam_periph_doacquire(struct cam_periph *periph);
  165 void            cam_periph_release(struct cam_periph *periph);
  166 void            cam_periph_release_locked(struct cam_periph *periph);
  167 void            cam_periph_release_locked_buses(struct cam_periph *periph);
  168 int             cam_periph_hold(struct cam_periph *periph, int priority);
  169 void            cam_periph_unhold(struct cam_periph *periph);
  170 void            cam_periph_invalidate(struct cam_periph *periph);
  171 int             cam_periph_mapmem(union ccb *ccb,
  172                                   struct cam_periph_map_info *mapinfo,
  173                                   u_int maxmap);
  174 void            cam_periph_unmapmem(union ccb *ccb,
  175                                     struct cam_periph_map_info *mapinfo);
  176 union ccb       *cam_periph_getccb(struct cam_periph *periph,
  177                                    u_int32_t priority);
  178 int             cam_periph_runccb(union ccb *ccb,
  179                                   int (*error_routine)(union ccb *ccb,
  180                                                        cam_flags camflags,
  181                                                        u_int32_t sense_flags),
  182                                   cam_flags camflags, u_int32_t sense_flags,
  183                                   struct devstat *ds);
  184 int             cam_periph_ioctl(struct cam_periph *periph, u_long cmd, 
  185                                  caddr_t addr,
  186                                  int (*error_routine)(union ccb *ccb,
  187                                                       cam_flags camflags,
  188                                                       u_int32_t sense_flags));
  189 void            cam_freeze_devq(struct cam_path *path);
  190 u_int32_t       cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
  191                                  u_int32_t opening_reduction, u_int32_t arg,
  192                                  int getcount_only);
  193 void            cam_periph_async(struct cam_periph *periph, u_int32_t code,
  194                                  struct cam_path *path, void *arg);
  195 void            cam_periph_bus_settle(struct cam_periph *periph,
  196                                       u_int bus_settle_ms);
  197 void            cam_periph_freeze_after_event(struct cam_periph *periph,
  198                                               struct timeval* event_time,
  199                                               u_int duration_ms);
  200 int             cam_periph_error(union ccb *ccb, cam_flags camflags,
  201                                  u_int32_t sense_flags);
  202 int             cam_periph_invalidate_sysctl(SYSCTL_HANDLER_ARGS);
  203 
  204 static __inline struct mtx *
  205 cam_periph_mtx(struct cam_periph *periph)
  206 {
  207         if (periph != NULL)
  208                 return (xpt_path_mtx(periph->path));
  209         else
  210                 return (NULL);
  211 }
  212 
  213 #define cam_periph_owned(periph)                                        \
  214         mtx_owned(xpt_path_mtx((periph)->path))
  215 
  216 #define cam_periph_lock(periph)                                         \
  217         mtx_lock(xpt_path_mtx((periph)->path))
  218 
  219 #define cam_periph_unlock(periph)                                       \
  220         mtx_unlock(xpt_path_mtx((periph)->path))
  221 
  222 #define cam_periph_assert(periph, what)                                 \
  223         mtx_assert(xpt_path_mtx((periph)->path), (what))
  224 
  225 #define cam_periph_sleep(periph, chan, priority, wmesg, timo)           \
  226         xpt_path_sleep((periph)->path, (chan), (priority), (wmesg), (timo))
  227 
  228 static inline struct cam_periph *
  229 cam_periph_acquire_first(struct periph_driver *driver)
  230 {
  231         struct cam_periph *periph;
  232 
  233         xpt_lock_buses();
  234         periph = TAILQ_FIRST(&driver->units);
  235         while (periph != NULL && (periph->flags & CAM_PERIPH_INVALID) != 0)
  236                 periph = TAILQ_NEXT(periph, unit_links);
  237         if (periph != NULL)
  238                 periph->refcount++;
  239         xpt_unlock_buses();
  240         return (periph);
  241 }
  242 
  243 static inline struct cam_periph *
  244 cam_periph_acquire_next(struct cam_periph *pperiph)
  245 {
  246         struct cam_periph *periph = pperiph;
  247 
  248         cam_periph_assert(pperiph, MA_NOTOWNED);
  249         xpt_lock_buses();
  250         do {
  251                 periph = TAILQ_NEXT(periph, unit_links);
  252         } while (periph != NULL && (periph->flags & CAM_PERIPH_INVALID) != 0);
  253         if (periph != NULL)
  254                 periph->refcount++;
  255         xpt_unlock_buses();
  256         cam_periph_release(pperiph);
  257         return (periph);
  258 }
  259 
  260 #define CAM_PERIPH_FOREACH(periph, driver)                              \
  261         for ((periph) = cam_periph_acquire_first(driver);               \
  262             (periph) != NULL;                                           \
  263             (periph) = cam_periph_acquire_next(periph))
  264 
  265 #define CAM_PERIPH_PRINT(p, msg, args...)                               \
  266     printf("%s%d:" msg, (periph)->periph_name, (periph)->unit_number, ##args)
  267 
  268 #endif /* _KERNEL */
  269 #endif /* _CAM_CAM_PERIPH_H */
Cache object: 97c38802a0acd69c63168ebcf256d871
[ 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/cam/cam_periph.h

FreeBSD/Linux Kernel Cross Reference
sys/cam/cam_periph.h
