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