drivers/scsi/isci/core/scic_controller.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 #ifndef _SCIC_CONTROLLER_H_
  57 #define _SCIC_CONTROLLER_H_
  58
  59 #include "sci_status.h"
  60 #include "sci_controller.h"
  61 #include "scic_config_parameters.h"
  62
  63 struct scic_sds_request;
  64 struct scic_sds_phy;
  65 struct scic_sds_port;
  66 struct scic_sds_remote_device;
  67
  68
  69 enum sci_controller_mode {
  70         SCI_MODE_SPEED,         /* Optimized for performance */
  71         SCI_MODE_SIZE           /* Optimized for memory use */
  72 };
  73
  74 enum sci_status scic_controller_construct(struct scic_sds_controller *c,
  75                                           void __iomem *scu_base,
  76                                           void __iomem *smu_base);
  77
  78 void scic_controller_enable_interrupts(
  79         struct scic_sds_controller *controller);
  80
  81 void scic_controller_disable_interrupts(
  82         struct scic_sds_controller *controller);
  83
  84 enum sci_status scic_controller_initialize(
  85         struct scic_sds_controller *controller);
  86
  87 u32 scic_controller_get_suggested_start_timeout(
  88         struct scic_sds_controller *controller);
  89
  90 enum sci_status scic_controller_start(
  91         struct scic_sds_controller *controller,
  92         u32 timeout);
  93
  94 enum sci_status scic_controller_stop(
  95         struct scic_sds_controller *controller,
  96         u32 timeout);
  97
  98 enum sci_status scic_controller_reset(
  99         struct scic_sds_controller *controller);
 100
 101 enum sci_status scic_controller_start_io(
 102         struct scic_sds_controller *controller,
 103         struct scic_sds_remote_device *remote_device,
 104         struct scic_sds_request *io_request,
 105         u16 io_tag);
 106
 107 enum sci_task_status scic_controller_start_task(
 108         struct scic_sds_controller *controller,
 109         struct scic_sds_remote_device *remote_device,
 110         struct scic_sds_request *task_request,
 111         u16 io_tag);
 112
 113 enum sci_status scic_controller_terminate_request(
 114         struct scic_sds_controller *controller,
 115         struct scic_sds_remote_device *remote_device,
 116         struct scic_sds_request *request);
 117
 118 enum sci_status scic_controller_complete_io(
 119         struct scic_sds_controller *controller,
 120         struct scic_sds_remote_device *remote_device,
 121         struct scic_sds_request *io_request);
 122
 123 enum sci_status scic_controller_get_phy_handle(
 124         struct scic_sds_controller *controller,
 125         u8 phy_index,
 126         struct scic_sds_phy **phy_handle);
 127
 128 u16 scic_controller_allocate_io_tag(
 129         struct scic_sds_controller *controller);
 130
 131 enum sci_status scic_controller_free_io_tag(
 132         struct scic_sds_controller *controller,
 133         u16 io_tag);
 134
 135 struct device;
 136 struct scic_sds_controller *scic_controller_alloc(struct device *dev);
 137 int scic_controller_mem_init(struct scic_sds_controller *scic);
 138 #endif  /* _SCIC_CONTROLLER_H_ */