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 * $FreeBSD$
53 */
54#ifndef _SATI_UNMAP_H_
55#define _SATI_UNMAP_H_
56
57/**
58 * @file
59 * @brief This file contains the method implementations required to
60 *        translate the SCSI reassign blocks command.
61 */
62
63#if !defined(DISABLE_SATI_UNMAP)
64
65#include <dev/isci/scil/sati_types.h>
66#include <dev/isci/scil/sati_translator_sequence.h>
67
68#define SATI_DSM_MAX_SECTOR_COUNT                     0xFFFF
69#define SATI_DSM_MAX_SECTOR_ADDRESS                   0xFFFFFFFFFFFF
70#define SATI_DSM_MAX_BUFFER_SIZE                      4096
71
72#define SATI_UNMAP_SIZEOF_SCSI_UNMAP_BLOCK_DESCRIPTOR 16
73#define SATI_UNMAP_SIZEOF_SCSI_UNMAP_PARAMETER_LIST   8
74
75typedef struct _TRIM_PAIR
76{
77    U64 sector_address:48;
78    U64 sector_count:16;
79} TRIM_PAIR, *PTRIM_PAIR;
80
81U32 sati_unmap_calculate_dsm_blocks(
82   SATI_TRANSLATOR_SEQUENCE_T * sequence,
83   U32                          dsm_descriptor_count
84);
85
86SATI_STATUS sati_unmap_construct(
87   SATI_TRANSLATOR_SEQUENCE_T * sequence,
88   void                       * scsi_io,
89   void                       * ata_io,
90   U32                          sector_count
91);
92
93SATI_STATUS sati_unmap_load_next_descriptor(
94   SATI_TRANSLATOR_SEQUENCE_T * sequence,
95   void                       * scsi_io
96);
97
98U32 sati_unmap_get_max_buffer_size_in_blocks(
99   SATI_TRANSLATOR_SEQUENCE_T * sequence
100);
101
102SATI_STATUS sati_unmap_initial_processing(
103   SATI_TRANSLATOR_SEQUENCE_T * sequence,
104   void                       * scsi_io,
105   void                       * ata_io
106);
107
108SATI_STATUS sati_unmap_process(
109   SATI_TRANSLATOR_SEQUENCE_T * sequence,
110   void                       * scsi_io,
111   void                       * ata_io
112);
113
114SATI_STATUS sati_unmap_translate_command(
115   SATI_TRANSLATOR_SEQUENCE_T * sequence,
116   void                       * scsi_io,
117   void                       * ata_io
118);
119
120SATI_STATUS sati_unmap_translate_response(
121   SATI_TRANSLATOR_SEQUENCE_T * sequence,
122   void                       * scsi_io,
123   void                       * ata_io
124);
125
126void sati_unmap_terminate(
127   SATI_TRANSLATOR_SEQUENCE_T * sequence,
128   void                       * scsi_io,
129   void                       * ata_io
130);
131#else // !defined(DISABLE_SATI_UNMAP)
132#define sati_unmap_terminate(sequence,scsi_io,ata_io)
133#endif // !defined(DISABLE_SATI_UNMAP)
134
135#endif // _SATI_UNMAP_H_
136