Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
2 * Copyright (c) 2017 Mellanox Technologies. All rights reserved.
3 * Copyright (c) 2017 Vadim Pasternak <vadimp@mellanox.com>
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#define MLXREG_CORE_LABEL_MAX_SIZE 32
38
39/**
40 * struct mlxreg_hotplug_device - I2C device data:
41 *
42 * @adapter: I2C device adapter;
43 * @client: I2C device client;
44 * @brdinfo: device board information;
45 * @nr: I2C device adapter number, to which device is to be attached;
46 *
47 * Structure represents I2C hotplug device static data (board topology) and
48 * dynamic data (related kernel objects handles).
49 */
50struct mlxreg_hotplug_device {
51 struct i2c_adapter *adapter;
52 struct i2c_client *client;
53 struct i2c_board_info *brdinfo;
54 int nr;
55};
56
57/**
58 * struct mlxreg_core_data - attributes control data:
59 *
60 * @label: attribute label;
61 * @reg: attribute register;
62 * @mask: attribute access mask;
63 * @bit: attribute effective bit;
64 * @mode: access mode;
65 * @np - pointer to node platform associated with attribute;
66 * @hpdev - hotplug device data;
67 * @health_cntr: dynamic device health indication counter;
68 * @attached: true if device has been attached after good health indication;
69 */
70struct mlxreg_core_data {
71 char label[MLXREG_CORE_LABEL_MAX_SIZE];
72 u32 reg;
73 u32 mask;
74 u32 bit;
75 umode_t mode;
76 struct device_node *np;
77 struct mlxreg_hotplug_device hpdev;
78 u8 health_cntr;
79 bool attached;
80};
81
82/**
83 * struct mlxreg_core_item - same type components controlled by the driver:
84 *
85 * @data: component data;
86 * @aggr_mask: group aggregation mask;
87 * @reg: group interrupt status register;
88 * @mask: group interrupt mask;
89 * @cache: last status value for elements fro the same group;
90 * @count: number of available elements in the group;
91 * @ind: element's index inside the group;
92 * @inversed: if 0: 0 for signal status is OK, if 1 - 1 is OK;
93 * @health: true if device has health indication, false in other case;
94 */
95struct mlxreg_core_item {
96 struct mlxreg_core_data *data;
97 u32 aggr_mask;
98 u32 reg;
99 u32 mask;
100 u32 cache;
101 u8 count;
102 u8 ind;
103 u8 inversed;
104 u8 health;
105};
106
107/**
108 * struct mlxreg_core_platform_data - platform data:
109 *
110 * @led_data: led private data;
111 * @regmap: register map of parent device;
112 * @counter: number of led instances;
113 */
114struct mlxreg_core_platform_data {
115 struct mlxreg_core_data *data;
116 void *regmap;
117 int counter;
118};
119
120/**
121 * struct mlxreg_core_hotplug_platform_data - hotplug platform data:
122 *
123 * @items: same type components with the hotplug capability;
124 * @irq: platform interrupt number;
125 * @regmap: register map of parent device;
126 * @counter: number of the components with the hotplug capability;
127 * @cell: location of top aggregation interrupt register;
128 * @mask: top aggregation interrupt common mask;
129 * @cell_low: location of low aggregation interrupt register;
130 * @mask_low: low aggregation interrupt common mask;
131 * @deferred_nr: I2C adapter number must be exist prior probing execution;
132 * @shift_nr: I2C adapter numbers must be incremented by this value;
133 */
134struct mlxreg_core_hotplug_platform_data {
135 struct mlxreg_core_item *items;
136 int irq;
137 void *regmap;
138 int counter;
139 u32 cell;
140 u32 mask;
141 u32 cell_low;
142 u32 mask_low;
143 int deferred_nr;
144 int shift_nr;
145};
146
147#endif /* __LINUX_PLATFORM_DATA_MLXREG_H */