drivers/scsi/isci/remote_device.h

   1 /*
   2  * This file is provided under a dual BSD/GPLv2 license.  When using or
   3  * redistributing this file, you may do so under either license.
   4  *
   5  * GPL LICENSE SUMMARY
   6  *
   7  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of version 2 of the GNU General Public License as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  21  * The full GNU General Public License is included in this distribution
  22  * in the file called LICENSE.GPL.
  23  *
  24  * BSD LICENSE
  25  *
  26  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
  27  * All rights reserved.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  *
  33  *   * Redistributions of source code must retain the above copyright
  34  *     notice, this list of conditions and the following disclaimer.
  35  *   * Redistributions in binary form must reproduce the above copyright
  36  *     notice, this list of conditions and the following disclaimer in
  37  *     the documentation and/or other materials provided with the
  38  *     distribution.
  39  *   * Neither the name of Intel Corporation nor the names of its
  40  *     contributors may be used to endorse or promote products derived
  41  *     from this software without specific prior written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  44  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  45  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  46  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  47  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  49  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  50  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  51  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  52  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  53  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  54  */
  55
  56 #if !defined(_ISCI_REMOTE_DEVICE_H_)
  57 #define _ISCI_REMOTE_DEVICE_H_
  58 #include "scic_user_callback.h"
  59
  60 struct isci_host;
  61 struct scic_sds_remote_device;
  62
  63 struct isci_remote_device {
  64         struct scic_sds_remote_device *sci_device_handle;
  65         enum isci_status status;
  66         struct isci_port *isci_port;
  67         struct domain_device *domain_dev;
  68         struct completion *completion;
  69         struct list_head node;
  70         struct list_head reqs_in_process;
  71         struct work_struct stop_work;
  72         spinlock_t state_lock;
  73         spinlock_t host_quiesce_lock;
  74         bool host_quiesce;
  75 };
  76
  77 #define to_isci_remote_device(p)        \
  78         container_of(p, struct isci_remote_device, sci_remote_device);
  79
  80 #define ISCI_REMOTE_DEVICE_START_TIMEOUT 5000
  81
  82
  83 /**
  84  * This function gets the status of the remote_device object.
  85  * @isci_device: This parameter points to the isci_remote_device object
  86  *
  87  * status of the object as a isci_status enum.
  88  */
  89 static inline
  90 enum isci_status isci_remote_device_get_state(
  91         struct isci_remote_device *isci_device)
  92 {
  93         return (isci_device->host_quiesce)
  94                ? isci_host_quiesce
  95                : isci_device->status;
  96 }
  97
  98
  99 /**
 100  * isci_dev_from_domain_dev() - This accessor retrieves the remote_device
 101  *    object reference from the Linux domain_device reference.
 102  * @domdev,: This parameter points to the Linux domain_device object .
 103  *
 104  * A reference to the associated isci remote device.
 105  */
 106 #define isci_dev_from_domain_dev(domdev) \
 107         ((struct isci_remote_device *)(domdev)->lldd_dev)
 108
 109 void isci_remote_device_start_complete(
 110         struct isci_host *,
 111         struct isci_remote_device *,
 112         enum sci_status);
 113
 114 void isci_remote_device_stop_complete(
 115         struct isci_host *,
 116         struct isci_remote_device *,
 117         enum sci_status);
 118
 119 enum sci_status isci_remote_device_stop(
 120         struct isci_remote_device *isci_device);
 121
 122 void isci_remote_device_nuke_requests(
 123         struct isci_remote_device *isci_device);
 124
 125 void isci_remote_device_ready(
 126         struct isci_remote_device *);
 127
 128 void isci_remote_device_not_ready(
 129         struct isci_remote_device *,
 130         u32);
 131
 132 void isci_remote_device_gone(
 133         struct domain_device *domain_dev);
 134
 135 int isci_remote_device_found(
 136         struct domain_device *domain_dev);
 137
 138 bool isci_device_is_reset_pending(
 139         struct isci_host *isci_host,
 140         struct isci_remote_device *isci_device);
 141
 142 void isci_device_clear_reset_pending(
 143         struct isci_remote_device *isci_device);
 144
 145 void isci_device_set_host_quiesce_lock_state(
 146         struct isci_remote_device *isci_device,
 147         bool lock_state);
 148
 149 void isci_remote_device_change_state(
 150         struct isci_remote_device *isci_device,
 151         enum isci_status status);
 152
 153 #endif /* !defined(_ISCI_REMOTE_DEVICE_H_) */
 154