blob: fcdc707eab9975f0a962038b8cdb1525f6614bf1 [file] [log] [blame]
Vadim Pasternak30488702016-10-20 16:28:01 +00001/*
Vadim Pasternak1f976f62018-01-17 18:21:53 +00002 * Copyright (c) 2017 Mellanox Technologies. All rights reserved.
3 * Copyright (c) 2017 Vadim Pasternak <vadimp@mellanox.com>
Vadim Pasternak30488702016-10-20 16:28:01 +00004 *
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
Vadim Pasternak1f976f62018-01-17 18:21:53 +000034#ifndef __LINUX_PLATFORM_DATA_MLXREG_H
35#define __LINUX_PLATFORM_DATA_MLXREG_H
Vadim Pasternak30488702016-10-20 16:28:01 +000036
Vadim Pasternakc6acad62018-01-22 19:55:11 -080037#define MLXREG_CORE_LABEL_MAX_SIZE 32
38
Vadim Pasternak30488702016-10-20 16:28:01 +000039/**
Vadim Pasternak1f976f62018-01-17 18:21:53 +000040 * struct mlxreg_hotplug_device - I2C device data:
Vadim Pasternakc6acad62018-01-22 19:55:11 -080041 *
Vadim Pasternak30488702016-10-20 16:28:01 +000042 * @adapter: I2C device adapter;
43 * @client: I2C device client;
44 * @brdinfo: device board information;
Vadim Pasternak3d838f52018-01-22 18:43:27 -080045 * @nr: I2C device adapter number, to which device is to be attached;
Vadim Pasternak30488702016-10-20 16:28:01 +000046 *
47 * Structure represents I2C hotplug device static data (board topology) and
48 * dynamic data (related kernel objects handles).
49 */
Vadim Pasternak1f976f62018-01-17 18:21:53 +000050struct mlxreg_hotplug_device {
Vadim Pasternak30488702016-10-20 16:28:01 +000051 struct i2c_adapter *adapter;
52 struct i2c_client *client;
Vadim Pasternakc6acad62018-01-22 19:55:11 -080053 struct i2c_board_info *brdinfo;
Vadim Pasternak3d838f52018-01-22 18:43:27 -080054 int nr;
Vadim Pasternak30488702016-10-20 16:28:01 +000055};
56
57/**
Vadim Pasternakc6acad62018-01-22 19:55:11 -080058 * struct mlxreg_core_data - attributes control data:
Vadim Pasternak30488702016-10-20 16:28:01 +000059 *
Vadim Pasternakc6acad62018-01-22 19:55:11 -080060 * @label: attribute label;
61 * @label: attribute register offset;
62 * @reg: attribute register;
63 * @mask: attribute access mask;
64 * @mode: access mode;
65 * @bit: attribute effective bit;
66 * @np - pointer to node platform associated with attribute;
67 * @hpdev - hotplug device data;
68 * @health_cntr: dynamic device health indication counter;
69 * @attached: true if device has been attached after good health indication;
Vadim Pasternak30488702016-10-20 16:28:01 +000070 */
Vadim Pasternakc6acad62018-01-22 19:55:11 -080071struct mlxreg_core_data {
72 char label[MLXREG_CORE_LABEL_MAX_SIZE];
73 u32 reg;
74 u32 mask;
75 u32 bit;
76 umode_t mode;
77 struct device_node *np;
78 struct mlxreg_hotplug_device hpdev;
79 u8 health_cntr;
80 bool attached;
81};
82
83/**
84 * struct mlxreg_core_item - same type components controlled by the driver:
85 *
86 * @data: component data;
87 * @aggr_mask: group aggregation mask;
88 * @reg: group interrupt status register;
89 * @mask: group interrupt mask;
90 * @cache: last status value for elements fro the same group;
91 * @count: number of available elements in the group;
92 * @ind: element's index inside the group;
93 * @inversed: if 0: 0 for signal status is OK, if 1 - 1 is OK;
94 * @health: true if device has health indication, false in other case;
95 */
96struct mlxreg_core_item {
97 struct mlxreg_core_data *data;
98 u32 aggr_mask;
99 u32 reg;
100 u32 mask;
101 u32 cache;
102 u8 count;
103 u8 ind;
104 u8 inversed;
105 u8 health;
106};
107
108/**
109 * struct mlxreg_core_platform_data - platform data:
110 *
111 * @led_data: led private data;
112 * @regmap: register map of parent device;
113 * @counter: number of led instances;
114 */
115struct mlxreg_core_platform_data {
116 struct mlxreg_core_data *data;
117 void *regmap;
118 int counter;
119};
120
121/**
122 * struct mlxreg_core_hotplug_platform_data - hotplug platform data:
123 *
124 * @items: same type components with the hotplug capability;
125 * @irq: platform interrupt number;
126 * @regmap: register map of parent device;
127 * @counter: number of the components with the hotplug capability;
128 * @cell: location of top aggregation interrupt register;
129 * @mask: top aggregation interrupt common mask;
130 * @cell_low: location of low aggregation interrupt register;
131 * @mask_low: low aggregation interrupt common mask;
132 */
133struct mlxreg_core_hotplug_platform_data {
134 struct mlxreg_core_item *items;
135 int irq;
136 void *regmap;
137 int counter;
138 u32 cell;
139 u32 mask;
140 u32 cell_low;
141 u32 mask_low;
Vadim Pasternak30488702016-10-20 16:28:01 +0000142};
143
Vadim Pasternak1f976f62018-01-17 18:21:53 +0000144#endif /* __LINUX_PLATFORM_DATA_MLXREG_H */