sys/bus/cam/cam_xpt.h

   1 /*
   2  * Data structures and definitions for dealing with the
   3  * Common Access Method Transport (xpt) layer.
   4  *
   5  * Copyright (c) 1997 Justin T. Gibbs.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions, and the following disclaimer,
  13  *    without modification, immediately at the beginning of the file.
  14  * 2. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  21  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD: src/sys/cam/cam_xpt.h,v 1.3 1999/12/29 04:54:27 peter Exp $
  30  */
  31
  32 #ifndef _CAM_CAM_XPT_H
  33 #define _CAM_CAM_XPT_H 1
  34
  35 /* Forward Declarations */
  36 union ccb;
  37 struct cam_periph;
  38 struct cam_sim;
  39
  40 /*
  41  * Definition of a CAM path.  Paths are created from bus, target, and lun ids
  42  * via xpt_create_path and allow for reference to devices without recurring
  43  * lookups in the edt.
  44  */
  45 struct cam_path;
  46
  47 /* Path functions */
  48
  49 #ifdef _KERNEL
  50
  51 void                    xpt_action(union ccb *new_ccb);
  52 void                    xpt_action_async(union ccb *ccb);
  53 void                    xpt_setup_ccb(struct ccb_hdr *ccb_h,
  54                                       struct cam_path *path,
  55                                       u_int32_t priority);
  56 void                    xpt_merge_ccb(union ccb *master_ccb,
  57                                       union ccb *slave_ccb);
  58 cam_status              xpt_create_path(struct cam_path **new_path_ptr,
  59                                         struct cam_periph *perph,
  60                                         path_id_t path_id,
  61                                         target_id_t target_id, lun_id_t lun_id);
  62 cam_status              xpt_create_path_unlocked(struct cam_path **new_path_ptr,
  63                                         struct cam_periph *perph,
  64                                         path_id_t path_id,
  65                                         target_id_t target_id, lun_id_t lun_id);
  66 void                    xpt_free_path(struct cam_path *path);
  67 int                     xpt_path_comp(struct cam_path *path1,
  68                                       struct cam_path *path2);
  69 void                    xpt_print_path(struct cam_path *path);
  70 void                    xpt_print(struct cam_path *path, const char *fmt, ...)
  71                             __printflike(2, 3);
  72 int                     xpt_path_string(struct cam_path *path, char *str,
  73                                         size_t str_len);
  74 path_id_t               xpt_path_path_id(struct cam_path *path);
  75 target_id_t             xpt_path_target_id(struct cam_path *path);
  76 lun_id_t                xpt_path_lun_id(struct cam_path *path);
  77 struct cam_sim *        xpt_path_sim(struct cam_path *path);
  78 struct cam_periph *     xpt_path_periph(struct cam_path *path);
  79 char *                  xpt_path_serialno(struct cam_path *path);
  80
  81 void                    xpt_async(u_int32_t async_code, struct cam_path *path,
  82                                   void *async_arg);
  83 void                    xpt_lock_buses(void);
  84 void                    xpt_unlock_buses(void);
  85 cam_status              xpt_register_async(int event, ac_callback_t *cbfunc,
  86                                            void *cbarg, struct cam_path *path);
  87 #endif /* _KERNEL */
  88
  89 #endif /* _CAM_CAM_XPT_H */
  90