/*      $NetBSD: scsipi_base.h,v 1.24 2017/02/26 10:58:47 maya Exp $    */

/*-
* Copyright (c) 1998, 2004 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Charles M. Hannum.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef _DEV_SCSIPI_SCSIPI_BASE_H_
#define _DEV_SCSIPI_SCSIPI_BASE_H_

struct scsipi_xfer *scsipi_get_xs(struct scsipi_periph *, int);
void    scsipi_put_xs(struct scsipi_xfer *);

static __inline struct scsipi_xfer *scsipi_make_xs_internal(struct scsipi_periph *,
           struct scsipi_generic *, int cmdlen, u_char *data_addr,
           int datalen, int retries, int timeout, struct buf *,
           int flags) __unused;

static __inline struct scsipi_xfer *scsipi_make_xs_unlocked(struct scsipi_periph *,
           struct scsipi_generic *, int cmdlen, u_char *data_addr,
           int datalen, int retries, int timeout, struct buf *,
           int flags) __unused;

static __inline struct scsipi_xfer *scsipi_make_xs_locked(struct scsipi_periph *,
           struct scsipi_generic *, int cmdlen, u_char *data_addr,
           int datalen, int retries, int timeout, struct buf *,
           int flags) __unused;

/*
* Make a scsipi_xfer, and return a pointer to it.
*/

static __inline struct scsipi_xfer *
scsipi_make_xs_internal(struct scsipi_periph *periph, struct scsipi_generic *cmd,
   int cmdlen, u_char *data_addr, int datalen, int retries, int timeout,
   struct buf *bp, int flags)
{
       struct scsipi_xfer *xs;

       if ((xs = scsipi_get_xs(periph, flags)) == NULL)
               return (NULL);

       /*
        * Fill out the scsipi_xfer structure.  We don't know whose context
        * the cmd is in, so copy it.
        */
       memcpy(&xs->cmdstore, cmd, cmdlen);
       xs->cmd = &xs->cmdstore;
       xs->cmdlen = cmdlen;
       xs->data = data_addr;
       xs->datalen = datalen;
       xs->xs_retries = retries;
       xs->timeout = timeout;
       xs->bp = bp;

       return (xs);
}

static __inline struct scsipi_xfer *
scsipi_make_xs_unlocked(struct scsipi_periph *periph, struct scsipi_generic *cmd,
   int cmdlen, u_char *data_addr, int datalen, int retries, int timeout,
   struct buf *bp, int flags)
{

       return scsipi_make_xs_internal(periph, cmd, cmdlen, data_addr,
           datalen, retries, timeout, bp, flags & ~XS_CTL_NOSLEEP);
}

static __inline struct scsipi_xfer *
scsipi_make_xs_locked(struct scsipi_periph *periph, struct scsipi_generic *cmd,
   int cmdlen, u_char *data_addr, int datalen, int retries, int timeout,
   struct buf *bp, int flags)
{

       KDASSERT(mutex_owned(chan_mtx(periph->periph_channel)));
       return scsipi_make_xs_internal(periph, cmd, cmdlen, data_addr,
           datalen, retries, timeout, bp, flags | XS_CTL_NOSLEEP);
}

#endif /* _DEV_SCSIPI_SCSIPI_BASE_H_ */