1/*-
2 * Copyright (c) 2011-2015 LSI Corp.
3 * Copyright (c) 2013-2016 Avago Technologies
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 *
27 * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
28 *
29 * $FreeBSD: stable/10/sys/dev/mpr/mpr_mapping.h 319436 2017-06-01 15:43:24Z slm $
30 */
31
32#ifndef _MPR_MAPPING_H
33#define _MPR_MAPPING_H
34
35/**
36 * struct _map_phy_change - PHY entries recieved in Topology change list
37 * @physical_id: SAS address of the device attached with the associate PHY
38 * @device_info: bitfield provides detailed info about the device
39 * @dev_handle: device handle for the device pointed by this entry
40 * @slot: slot ID
41 * @is_processed: Flag to indicate whether this entry is processed or not
42 * @is_SATA_SSD: 1 if this is a SATA device AND an SSD, 0 otherwise
43 */
44struct _map_phy_change {
45	uint64_t	physical_id;
46	uint32_t	device_info;
47	uint16_t	dev_handle;
48	uint16_t	slot;
49	uint8_t	reason;
50	uint8_t	is_processed;
51	uint8_t	is_SATA_SSD;
52	uint8_t reserved;
53};
54
55/**
56 * struct _map_port_change - PCIe Port entries received in PCIe Topology change
57 * list event
58 * @physical_id: WWID of the device attached to the associated port
59 * @device_info: bitfield provides detailed info about the device
60 * @MDTS: Maximum Data Transfer Size for the device
61 * @dev_handle: device handle for the device pointed by this entry
62 * @slot: slot ID
63 * @is_processed: Flag to indicate whether this entry is processed or not
64 */
65struct _map_port_change {
66	uint64_t	physical_id;
67	uint32_t	device_info;
68	uint32_t	MDTS;
69	uint16_t	dev_handle;
70	uint16_t	slot;
71	uint8_t		reason;
72	uint8_t		is_processed;
73	uint8_t		reserved[2];
74};
75
76/**
77 * struct _map_topology_change - SAS/SATA entries to be removed from mapping
78 * table
79 * @enc_handle: enclosure handle where this device is located
80 * @exp_handle: expander handle where this device is located
81 * @num_entries: number of entries in the SAS Topology Change List event
82 * @start_phy_num: PHY number of the first PHY in the event data
83 * @num_phys: number of PHYs in the expander where this device is located
84 * @exp_status: status for the expander where this device is located
85 * @phy_details: more details about each PHY in the event data
86 */
87struct _map_topology_change {
88	uint16_t	enc_handle;
89	uint16_t	exp_handle;
90	uint8_t	num_entries;
91	uint8_t	start_phy_num;
92	uint8_t	num_phys;
93	uint8_t	exp_status;
94	struct _map_phy_change *phy_details;
95};
96
97/**
98 * struct _map_pcie_topology_change - PCIe entries to be removed from mapping
99 * table
100 * @enc_handle: enclosure handle where this device is located
101 * @switch_dev_handle:  PCIe switch device handle where this device is located
102 * @num_entries: number of entries in the PCIe Topology Change List event
103 * @start_port_num: port number of the first port in the event data
104 * @num_ports: number of ports in the PCIe switch device
105 * @switch_status: status for the PCIe switch where this device is located
106 * @port_details: more details about each Port in the event data
107 */
108struct _map_pcie_topology_change {
109	uint16_t	enc_handle;
110	uint16_t	switch_dev_handle;
111	uint8_t	num_entries;
112	uint8_t	start_port_num;
113	uint8_t	num_ports;
114	uint8_t switch_status;
115	struct _map_port_change *port_details;
116};
117
118extern int
119mprsas_get_sas_address_for_sata_disk(struct mpr_softc *ioc,
120    u64 *sas_address, u16 handle, u32 device_info, u8 *is_SATA_SSD);
121
122#endif
123