include/linux/platform_data/mlxreg.h

   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 #define MLXREG_CORE_WD_FEATURE_NOWAYOUT         BIT(0)
  39 #define MLXREG_CORE_WD_FEATURE_START_AT_BOOT    BIT(1)
  40
  41 /**
  42  * enum mlxreg_wdt_type - type of HW watchdog
  43  *
  44  * TYPE1 HW watchdog implementation exist in old systems.
  45  * All new systems have TYPE2 HW watchdog.
  46  * TYPE3 HW watchdog can exist on all systems with new CPLD.
  47  * TYPE3 is selected by WD capability bit.
  48  */
  49 enum mlxreg_wdt_type {
  50         MLX_WDT_TYPE1,
  51         MLX_WDT_TYPE2,
  52         MLX_WDT_TYPE3,
  53 };
  54
  55 /**
  56  * struct mlxreg_hotplug_device - I2C device data:
  57  *
  58  * @adapter: I2C device adapter;
  59  * @client: I2C device client;
  60  * @brdinfo: device board information;
  61  * @nr: I2C device adapter number, to which device is to be attached;
  62  *
  63  * Structure represents I2C hotplug device static data (board topology) and
  64  * dynamic data (related kernel objects handles).
  65  */
  66 struct mlxreg_hotplug_device {
  67         struct i2c_adapter *adapter;
  68         struct i2c_client *client;
  69         struct i2c_board_info *brdinfo;
  70         int nr;
  71 };
  72
  73 /**
  74  * struct mlxreg_core_data - attributes control data:
  75  *
  76  * @label: attribute label;
  77  * @reg: attribute register;
  78  * @mask: attribute access mask;
  79  * @bit: attribute effective bit;
  80  * @capability: attribute capability register;
  81  * @reg_prsnt: attribute presence register;
  82  * @mode: access mode;
  83  * @np - pointer to node platform associated with attribute;
  84  * @hpdev - hotplug device data;
  85  * @health_cntr: dynamic device health indication counter;
  86  * @attached: true if device has been attached after good health indication;
  87  * @regnum: number of registers occupied by multi-register attribute;
  88  */
  89 struct mlxreg_core_data {
  90         char label[MLXREG_CORE_LABEL_MAX_SIZE];
  91         u32 reg;
  92         u32 mask;
  93         u32 bit;
  94         u32 capability;
  95         u32 reg_prsnt;
  96         umode_t mode;
  97         struct device_node *np;
  98         struct mlxreg_hotplug_device hpdev;
  99         u32 health_cntr;
 100         bool attached;
 101         u8 regnum;
 102 };
 103
 104 /**
 105  * struct mlxreg_core_item - same type components controlled by the driver:
 106  *
 107  * @data: component data;
 108  * @aggr_mask: group aggregation mask;
 109  * @reg: group interrupt status register;
 110  * @mask: group interrupt mask;
 111  * @capability: group capability register;
 112  * @cache: last status value for elements fro the same group;
 113  * @count: number of available elements in the group;
 114  * @ind: element's index inside the group;
 115  * @inversed: if 0: 0 for signal status is OK, if 1 - 1 is OK;
 116  * @health: true if device has health indication, false in other case;
 117  */
 118 struct mlxreg_core_item {
 119         struct mlxreg_core_data *data;
 120         u32 aggr_mask;
 121         u32 reg;
 122         u32 mask;
 123         u32 capability;
 124         u32 cache;
 125         u8 count;
 126         u8 ind;
 127         u8 inversed;
 128         u8 health;
 129 };
 130
 131 /**
 132  * struct mlxreg_core_platform_data - platform data:
 133  *
 134  * @data: instance private data;
 135  * @regmap: register map of parent device;
 136  * @counter: number of instances;
 137  * @features: supported features of device;
 138  * @version: implementation version;
 139  * @identity: device identity name;
 140  */
 141 struct mlxreg_core_platform_data {
 142         struct mlxreg_core_data *data;
 143         void *regmap;
 144         int counter;
 145         u32 features;
 146         u32 version;
 147         char identity[MLXREG_CORE_LABEL_MAX_SIZE];
 148 };
 149
 150 /**
 151  * struct mlxreg_core_hotplug_platform_data - hotplug platform data:
 152  *
 153  * @items: same type components with the hotplug capability;
 154  * @irq: platform interrupt number;
 155  * @regmap: register map of parent device;
 156  * @counter: number of the components with the hotplug capability;
 157  * @cell: location of top aggregation interrupt register;
 158  * @mask: top aggregation interrupt common mask;
 159  * @cell_low: location of low aggregation interrupt register;
 160  * @mask_low: low aggregation interrupt common mask;
 161  * @deferred_nr: I2C adapter number must be exist prior probing execution;
 162  * @shift_nr: I2C adapter numbers must be incremented by this value;
 163  */
 164 struct mlxreg_core_hotplug_platform_data {
 165         struct mlxreg_core_item *items;
 166         int irq;
 167         void *regmap;
 168         int counter;
 169         u32 cell;
 170         u32 mask;
 171         u32 cell_low;
 172         u32 mask_low;
 173         int deferred_nr;
 174         int shift_nr;
 175 };
 176
 177 #endif /* __LINUX_PLATFORM_DATA_MLXREG_H */