sys/dev/isci/scil/sati_report_luns.c

   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  *
  40  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  41  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  42  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  43  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  44  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  46  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  47  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  48  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  49  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  50  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  51  */
  52
  53 #include <sys/cdefs.h>
  54 __FBSDID("$FreeBSD$");
  55
  56 /**
  57  * @file
  58  * @brief This file contains the method implementations required to
  59  *        translate the SCSI REPORT LUNS command.
  60  */
  61
  62 #if !defined(DISABLE_SATI_REPORT_LUNS)
  63
  64 #include <dev/isci/scil/sati_report_luns.h>
  65 #include <dev/isci/scil/sati_callbacks.h>
  66 #include <dev/isci/scil/sati_util.h>
  67 #include <dev/isci/scil/intel_ata.h>
  68 #include <dev/isci/scil/intel_scsi.h>
  69
  70 /**
  71  * @brief This method will translate the REPORT LUN SCSI command.  This
  72  *        command is immediately completed, since there is no applicable
  73  *        ATA/ATAPI command.  The data payload is written and SATI_COMPLETE
  74  *        is always returned.
  75  *        For more information on the parameters passed to this method,
  76  *        please reference sati_translate_command().
  77  *
  78  * @return This method always indicates the translation is complete.
  79  * @retval SATI_COMPLETE This value is always returned.
  80  */
  81 SATI_STATUS sati_report_luns_translate_command(
  82    SATI_TRANSLATOR_SEQUENCE_T * sequence,
  83    void                       * scsi_io,
  84    void                       * ata_io
  85 )
  86 {
  87    U8 * cdb = sati_cb_get_cdb_address(scsi_io);
  88
  89    // Set the data length based on the allocation length field in the CDB.
  90    sequence->allocation_length = (sati_get_cdb_byte(cdb, 6) << 24) |
  91                                  (sati_get_cdb_byte(cdb, 7) << 16) |
  92                                  (sati_get_cdb_byte(cdb, 8) << 8)  |
  93                                  (sati_get_cdb_byte(cdb, 9));
  94
  95    // The first 4 bytes indicate the length of the LUN list.  Each
  96    // LUN entry is 8 bytes.  There is only ever LUN 0 for ATA/ATAPI
  97    // devices.  The value reported is: n-7, where n is the last byte
  98    // offset (i.e. 15) in the REPORT LUN data.
  99    sati_set_data_byte(sequence, scsi_io, 0, 0);
 100    sati_set_data_byte(sequence, scsi_io, 1, 0);
 101    sati_set_data_byte(sequence, scsi_io, 2, 0);
 102    sati_set_data_byte(sequence, scsi_io, 3, 8);
 103
 104    // Bytes 4-7 are reserved.
 105    sati_set_data_byte(sequence, scsi_io, 4, 0);
 106    sati_set_data_byte(sequence, scsi_io, 5, 0);
 107    sati_set_data_byte(sequence, scsi_io, 6, 0);
 108    sati_set_data_byte(sequence, scsi_io, 7, 0);
 109
 110    // Add in our single LUN of zero.
 111    sati_set_data_byte(sequence, scsi_io, 8, 0);
 112    sati_set_data_byte(sequence, scsi_io, 9, 0);
 113    sati_set_data_byte(sequence, scsi_io, 10, 0);
 114    sati_set_data_byte(sequence, scsi_io, 11, 0);
 115    sati_set_data_byte(sequence, scsi_io, 12, 0);
 116    sati_set_data_byte(sequence, scsi_io, 13, 0);
 117    sati_set_data_byte(sequence, scsi_io, 14, 0);
 118    sati_set_data_byte(sequence, scsi_io, 15, 0);
 119
 120    return SATI_COMPLETE;
 121 }
 122
 123 #endif // !defined(DISABLE_SATI_REPORT_LUNS)
 124