sys/cam/cam_xpt_periph.h

   1 /*-
   2  * Data structures and definitions for dealing with the
   3  * Common Access Method Transport (xpt) layer from peripheral
   4  * drivers.
   5  *
   6  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   7  *
   8  * Copyright (c) 1997 Justin T. Gibbs.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification, immediately at the beginning of the file.
  17  * 2. The name of the author may not be used to endorse or promote products
  18  *    derived from this software without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  24  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _CAM_CAM_XPT_PERIPH_H
  36 #define _CAM_CAM_XPT_PERIPH_H 1
  37
  38 #include <cam/cam_queue.h>
  39 #include <cam/cam_xpt.h>
  40
  41 /* Functions accessed by the peripheral drivers */
  42 #ifdef _KERNEL
  43 void            xpt_polled_action(union ccb *ccb);
  44 void            xpt_release_ccb(union ccb *released_ccb);
  45 void            xpt_schedule(struct cam_periph *perph, u_int32_t new_priority);
  46 int32_t         xpt_add_periph(struct cam_periph *periph);
  47 void            xpt_remove_periph(struct cam_periph *periph);
  48 void            xpt_announce_periph(struct cam_periph *periph,
  49                                     char *announce_string);
  50 void            xpt_announce_periph_sbuf(struct cam_periph *periph,
  51                                          struct sbuf *sb,
  52                                          char *announce_string);
  53 void            xpt_announce_quirks(struct cam_periph *periph,
  54                                     int quirks, char *bit_string);
  55 void            xpt_announce_quirks_sbuf(struct cam_periph *periph,
  56                                     struct sbuf *sb,
  57                                     int quirks, char *bit_string);
  58 void            xpt_denounce_periph(struct cam_periph *periph);
  59 void            xpt_denounce_periph_sbuf(struct cam_periph *periph, struct sbuf *sb);
  60 #endif
  61
  62 #endif /* _CAM_CAM_XPT_PERIPH_H */