1 /*
2  * Copyright (c) 2017 Mellanox Technologies. All rights reserved.
3  * Copyright (c) 2017 Vadim Pasternak <[email protected]>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the names of the copyright holders nor the names of its
14  *    contributors may be used to endorse or promote products derived from
15  *    this software without specific prior written permission.
16  *
17  * Alternatively, this software may be distributed under the terms of the
18  * GNU General Public License ("GPL") version 2 as published by the Free
19  * Software Foundation.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef __LINUX_PLATFORM_DATA_MLXREG_H
35 #define __LINUX_PLATFORM_DATA_MLXREG_H
36 
37 /**
38  * struct mlxreg_hotplug_device - I2C device data:
39  * @adapter: I2C device adapter;
40  * @client: I2C device client;
41  * @brdinfo: device board information;
42  * @bus: I2C bus, where device is attached;
43  *
44  * Structure represents I2C hotplug device static data (board topology) and
45  * dynamic data (related kernel objects handles).
46  */
47 struct mlxreg_hotplug_device {
48 	struct i2c_adapter *adapter;
49 	struct i2c_client *client;
50 	struct i2c_board_info brdinfo;
51 	u16 bus;
52 };
53 
54 /**
55  * struct mlxreg_hotplug_platform_data - device platform data:
56  * @top_aggr_offset: offset of top aggregation interrupt register;
57  * @top_aggr_mask: top aggregation interrupt common mask;
58  * @top_aggr_psu_mask: top aggregation interrupt PSU mask;
59  * @psu_reg_offset: offset of PSU interrupt register;
60  * @psu_mask: PSU interrupt mask;
61  * @psu_count: number of equipped replaceable PSUs;
62  * @psu: pointer to PSU devices data array;
63  * @top_aggr_pwr_mask: top aggregation interrupt power mask;
64  * @pwr_reg_offset: offset of power interrupt register
65  * @pwr_mask: power interrupt mask;
66  * @pwr_count: number of power sources;
67  * @pwr: pointer to power devices data array;
68  * @top_aggr_fan_mask: top aggregation interrupt FAN mask;
69  * @fan_reg_offset: offset of FAN interrupt register;
70  * @fan_mask: FAN interrupt mask;
71  * @fan_count: number of equipped replaceable FANs;
72  * @fan: pointer to FAN devices data array;
73  *
74  * Structure represents board platform data, related to system hotplug events,
75  * like FAN, PSU, power cable insertion and removing. This data provides the
76  * number of hot-pluggable devices and hardware description for event handling.
77  */
78 struct mlxreg_hotplug_platform_data {
79 	u16 top_aggr_offset;
80 	u8 top_aggr_mask;
81 	u8 top_aggr_psu_mask;
82 	u16 psu_reg_offset;
83 	u8 psu_mask;
84 	u8 psu_count;
85 	struct mlxreg_hotplug_device *psu;
86 	u8 top_aggr_pwr_mask;
87 	u16 pwr_reg_offset;
88 	u8 pwr_mask;
89 	u8 pwr_count;
90 	struct mlxreg_hotplug_device *pwr;
91 	u8 top_aggr_fan_mask;
92 	u16 fan_reg_offset;
93 	u8 fan_mask;
94 	u8 fan_count;
95 	struct mlxreg_hotplug_device *fan;
96 };
97 
98 #endif /* __LINUX_PLATFORM_DATA_MLXREG_H */
99