1/*-
2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
3 *
4 * This file is provided under a dual BSD/GPLv2 license.  When using or
5 * redistributing this file, you may do so under either license.
6 *
7 * GPL LICENSE SUMMARY
8 *
9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of version 2 of the GNU General Public License as
13 * published by the Free Software Foundation.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
23 * The full GNU General Public License is included in this distribution
24 * in the file called LICENSE.GPL.
25 *
26 * BSD LICENSE
27 *
28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29 * All rights reserved.
30 *
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
33 * are met:
34 *
35 *   * Redistributions of source code must retain the above copyright
36 *     notice, this list of conditions and the following disclaimer.
37 *   * Redistributions in binary form must reproduce the above copyright
38 *     notice, this list of conditions and the following disclaimer in
39 *     the documentation and/or other materials provided with the
40 *     distribution.
41 *
42 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
43 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
44 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
45 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
46 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
47 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
48 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
49 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
50 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
51 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
52 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
53 *
54 * $FreeBSD$
55 */
56#ifndef _SATI_UNMAP_H_
57#define _SATI_UNMAP_H_
58
59/**
60 * @file
61 * @brief This file contains the method implementations required to
62 *        translate the SCSI reassign blocks command.
63 */
64
65#if !defined(DISABLE_SATI_UNMAP)
66
67#include <dev/isci/scil/sati_types.h>
68#include <dev/isci/scil/sati_translator_sequence.h>
69
70#define SATI_DSM_MAX_SECTOR_COUNT                     0xFFFF
71#define SATI_DSM_MAX_SECTOR_ADDRESS                   0xFFFFFFFFFFFF
72#define SATI_DSM_MAX_BUFFER_SIZE                      4096
73
74#define SATI_UNMAP_SIZEOF_SCSI_UNMAP_BLOCK_DESCRIPTOR 16
75#define SATI_UNMAP_SIZEOF_SCSI_UNMAP_PARAMETER_LIST   8
76
77typedef struct _TRIM_PAIR
78{
79    U64 sector_address:48;
80    U64 sector_count:16;
81} TRIM_PAIR, *PTRIM_PAIR;
82
83U32 sati_unmap_calculate_dsm_blocks(
84   SATI_TRANSLATOR_SEQUENCE_T * sequence,
85   U32                          dsm_descriptor_count
86);
87
88SATI_STATUS sati_unmap_construct(
89   SATI_TRANSLATOR_SEQUENCE_T * sequence,
90   void                       * scsi_io,
91   void                       * ata_io,
92   U32                          sector_count
93);
94
95SATI_STATUS sati_unmap_load_next_descriptor(
96   SATI_TRANSLATOR_SEQUENCE_T * sequence,
97   void                       * scsi_io
98);
99
100U32 sati_unmap_get_max_buffer_size_in_blocks(
101   SATI_TRANSLATOR_SEQUENCE_T * sequence
102);
103
104SATI_STATUS sati_unmap_initial_processing(
105   SATI_TRANSLATOR_SEQUENCE_T * sequence,
106   void                       * scsi_io,
107   void                       * ata_io
108);
109
110SATI_STATUS sati_unmap_process(
111   SATI_TRANSLATOR_SEQUENCE_T * sequence,
112   void                       * scsi_io,
113   void                       * ata_io
114);
115
116SATI_STATUS sati_unmap_translate_command(
117   SATI_TRANSLATOR_SEQUENCE_T * sequence,
118   void                       * scsi_io,
119   void                       * ata_io
120);
121
122SATI_STATUS sati_unmap_translate_response(
123   SATI_TRANSLATOR_SEQUENCE_T * sequence,
124   void                       * scsi_io,
125   void                       * ata_io
126);
127
128void sati_unmap_terminate(
129   SATI_TRANSLATOR_SEQUENCE_T * sequence,
130   void                       * scsi_io,
131   void                       * ata_io
132);
133#else // !defined(DISABLE_SATI_UNMAP)
134#define sati_unmap_terminate(sequence,scsi_io,ata_io)
135#endif // !defined(DISABLE_SATI_UNMAP)
136
137#endif // _SATI_UNMAP_H_
138