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 * $FreeBSD$
31 */
32
33#ifndef _MPR_MAPPING_H
34#define _MPR_MAPPING_H
35
36/**
37 * struct _map_phy_change - PHY entries received in Topology change list
38 * @physical_id: SAS address of the device attached with the associate PHY
39 * @device_info: bitfield provides detailed info about the device
40 * @dev_handle: device handle for the device pointed by this entry
41 * @slot: slot ID
42 * @is_processed: Flag to indicate whether this entry is processed or not
43 * @is_SATA_SSD: 1 if this is a SATA device AND an SSD, 0 otherwise
44 */
45struct _map_phy_change {
46	uint64_t	physical_id;
47	uint32_t	device_info;
48	uint16_t	dev_handle;
49	uint16_t	slot;
50	uint8_t	reason;
51	uint8_t	is_processed;
52	uint8_t	is_SATA_SSD;
53	uint8_t reserved;
54};
55
56/**
57 * struct _map_port_change - PCIe Port entries received in PCIe Topology change
58 * list event
59 * @physical_id: WWID of the device attached to the associated port
60 * @device_info: bitfield provides detailed info about the device
61 * @MDTS: Maximum Data Transfer Size for the device
62 * @dev_handle: device handle for the device pointed by this entry
63 * @slot: slot ID
64 * @is_processed: Flag to indicate whether this entry is processed or not
65 */
66struct _map_port_change {
67	uint64_t	physical_id;
68	uint32_t	device_info;
69	uint32_t	MDTS;
70	uint16_t	dev_handle;
71	uint16_t	slot;
72	uint8_t		reason;
73	uint8_t		is_processed;
74	uint8_t		reserved[2];
75};
76
77/**
78 * struct _map_topology_change - SAS/SATA entries to be removed from mapping
79 * table
80 * @enc_handle: enclosure handle where this device is located
81 * @exp_handle: expander handle where this device is located
82 * @num_entries: number of entries in the SAS Topology Change List event
83 * @start_phy_num: PHY number of the first PHY in the event data
84 * @num_phys: number of PHYs in the expander where this device is located
85 * @exp_status: status for the expander where this device is located
86 * @phy_details: more details about each PHY in the event data
87 */
88struct _map_topology_change {
89	uint16_t	enc_handle;
90	uint16_t	exp_handle;
91	uint8_t	num_entries;
92	uint8_t	start_phy_num;
93	uint8_t	num_phys;
94	uint8_t	exp_status;
95	struct _map_phy_change *phy_details;
96};
97
98/**
99 * struct _map_pcie_topology_change - PCIe entries to be removed from mapping
100 * table
101 * @enc_handle: enclosure handle where this device is located
102 * @switch_dev_handle:  PCIe switch device handle where this device is located
103 * @num_entries: number of entries in the PCIe Topology Change List event
104 * @start_port_num: port number of the first port in the event data
105 * @num_ports: number of ports in the PCIe switch device
106 * @switch_status: status for the PCIe switch where this device is located
107 * @port_details: more details about each Port in the event data
108 */
109struct _map_pcie_topology_change {
110	uint16_t	enc_handle;
111	uint16_t	switch_dev_handle;
112	uint8_t	num_entries;
113	uint8_t	start_port_num;
114	uint8_t	num_ports;
115	uint8_t switch_status;
116	struct _map_port_change *port_details;
117};
118
119extern int
120mprsas_get_sas_address_for_sata_disk(struct mpr_softc *ioc,
121    u64 *sas_address, u16 handle, u32 device_info, u8 *is_SATA_SSD);
122
123#endif
124