1 /* 2 * pmbus.h - Common defines and structures for PMBus devices 3 * 4 * Copyright (c) 2010, 2011 Ericsson AB. 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation; either version 2 of the License, or 9 * (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program; if not, write to the Free Software 18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 19 */ 20 21 #ifndef PMBUS_H 22 #define PMBUS_H 23 24 /* 25 * Registers 26 */ 27 #define PMBUS_PAGE 0x00 28 #define PMBUS_OPERATION 0x01 29 #define PMBUS_ON_OFF_CONFIG 0x02 30 #define PMBUS_CLEAR_FAULTS 0x03 31 #define PMBUS_PHASE 0x04 32 33 #define PMBUS_CAPABILITY 0x19 34 #define PMBUS_QUERY 0x1A 35 36 #define PMBUS_VOUT_MODE 0x20 37 #define PMBUS_VOUT_COMMAND 0x21 38 #define PMBUS_VOUT_TRIM 0x22 39 #define PMBUS_VOUT_CAL_OFFSET 0x23 40 #define PMBUS_VOUT_MAX 0x24 41 #define PMBUS_VOUT_MARGIN_HIGH 0x25 42 #define PMBUS_VOUT_MARGIN_LOW 0x26 43 #define PMBUS_VOUT_TRANSITION_RATE 0x27 44 #define PMBUS_VOUT_DROOP 0x28 45 #define PMBUS_VOUT_SCALE_LOOP 0x29 46 #define PMBUS_VOUT_SCALE_MONITOR 0x2A 47 48 #define PMBUS_COEFFICIENTS 0x30 49 #define PMBUS_POUT_MAX 0x31 50 51 #define PMBUS_FAN_CONFIG_12 0x3A 52 #define PMBUS_FAN_COMMAND_1 0x3B 53 #define PMBUS_FAN_COMMAND_2 0x3C 54 #define PMBUS_FAN_CONFIG_34 0x3D 55 #define PMBUS_FAN_COMMAND_3 0x3E 56 #define PMBUS_FAN_COMMAND_4 0x3F 57 58 #define PMBUS_VOUT_OV_FAULT_LIMIT 0x40 59 #define PMBUS_VOUT_OV_FAULT_RESPONSE 0x41 60 #define PMBUS_VOUT_OV_WARN_LIMIT 0x42 61 #define PMBUS_VOUT_UV_WARN_LIMIT 0x43 62 #define PMBUS_VOUT_UV_FAULT_LIMIT 0x44 63 #define PMBUS_VOUT_UV_FAULT_RESPONSE 0x45 64 #define PMBUS_IOUT_OC_FAULT_LIMIT 0x46 65 #define PMBUS_IOUT_OC_FAULT_RESPONSE 0x47 66 #define PMBUS_IOUT_OC_LV_FAULT_LIMIT 0x48 67 #define PMBUS_IOUT_OC_LV_FAULT_RESPONSE 0x49 68 #define PMBUS_IOUT_OC_WARN_LIMIT 0x4A 69 #define PMBUS_IOUT_UC_FAULT_LIMIT 0x4B 70 #define PMBUS_IOUT_UC_FAULT_RESPONSE 0x4C 71 72 #define PMBUS_OT_FAULT_LIMIT 0x4F 73 #define PMBUS_OT_FAULT_RESPONSE 0x50 74 #define PMBUS_OT_WARN_LIMIT 0x51 75 #define PMBUS_UT_WARN_LIMIT 0x52 76 #define PMBUS_UT_FAULT_LIMIT 0x53 77 #define PMBUS_UT_FAULT_RESPONSE 0x54 78 #define PMBUS_VIN_OV_FAULT_LIMIT 0x55 79 #define PMBUS_VIN_OV_FAULT_RESPONSE 0x56 80 #define PMBUS_VIN_OV_WARN_LIMIT 0x57 81 #define PMBUS_VIN_UV_WARN_LIMIT 0x58 82 #define PMBUS_VIN_UV_FAULT_LIMIT 0x59 83 84 #define PMBUS_IIN_OC_FAULT_LIMIT 0x5B 85 #define PMBUS_IIN_OC_WARN_LIMIT 0x5D 86 87 #define PMBUS_POUT_OP_FAULT_LIMIT 0x68 88 #define PMBUS_POUT_OP_WARN_LIMIT 0x6A 89 #define PMBUS_PIN_OP_WARN_LIMIT 0x6B 90 91 #define PMBUS_STATUS_BYTE 0x78 92 #define PMBUS_STATUS_WORD 0x79 93 #define PMBUS_STATUS_VOUT 0x7A 94 #define PMBUS_STATUS_IOUT 0x7B 95 #define PMBUS_STATUS_INPUT 0x7C 96 #define PMBUS_STATUS_TEMPERATURE 0x7D 97 #define PMBUS_STATUS_CML 0x7E 98 #define PMBUS_STATUS_OTHER 0x7F 99 #define PMBUS_STATUS_MFR_SPECIFIC 0x80 100 #define PMBUS_STATUS_FAN_12 0x81 101 #define PMBUS_STATUS_FAN_34 0x82 102 103 #define PMBUS_READ_VIN 0x88 104 #define PMBUS_READ_IIN 0x89 105 #define PMBUS_READ_VCAP 0x8A 106 #define PMBUS_READ_VOUT 0x8B 107 #define PMBUS_READ_IOUT 0x8C 108 #define PMBUS_READ_TEMPERATURE_1 0x8D 109 #define PMBUS_READ_TEMPERATURE_2 0x8E 110 #define PMBUS_READ_TEMPERATURE_3 0x8F 111 #define PMBUS_READ_FAN_SPEED_1 0x90 112 #define PMBUS_READ_FAN_SPEED_2 0x91 113 #define PMBUS_READ_FAN_SPEED_3 0x92 114 #define PMBUS_READ_FAN_SPEED_4 0x93 115 #define PMBUS_READ_DUTY_CYCLE 0x94 116 #define PMBUS_READ_FREQUENCY 0x95 117 #define PMBUS_READ_POUT 0x96 118 #define PMBUS_READ_PIN 0x97 119 120 #define PMBUS_REVISION 0x98 121 #define PMBUS_MFR_ID 0x99 122 #define PMBUS_MFR_MODEL 0x9A 123 #define PMBUS_MFR_REVISION 0x9B 124 #define PMBUS_MFR_LOCATION 0x9C 125 #define PMBUS_MFR_DATE 0x9D 126 #define PMBUS_MFR_SERIAL 0x9E 127 128 /* 129 * Virtual registers. 130 * Useful to support attributes which are not supported by standard PMBus 131 * registers but exist as manufacturer specific registers on individual chips. 132 * Must be mapped to real registers in device specific code. 133 * 134 * Semantics: 135 * Virtual registers are all word size. 136 * READ registers are read-only; writes are either ignored or return an error. 137 * RESET registers are read/write. Reading reset registers returns zero 138 * (used for detection), writing any value causes the associated history to be 139 * reset. 140 * Virtual registers have to be handled in device specific driver code. Chip 141 * driver code returns non-negative register values if a virtual register is 142 * supported, or a negative error code if not. The chip driver may return 143 * -ENODATA or any other error code in this case, though an error code other 144 * than -ENODATA is handled more efficiently and thus preferred. Either case, 145 * the calling PMBus core code will abort if the chip driver returns an error 146 * code when reading or writing virtual registers. 147 */ 148 #define PMBUS_VIRT_BASE 0x100 149 #define PMBUS_VIRT_READ_TEMP_AVG (PMBUS_VIRT_BASE + 0) 150 #define PMBUS_VIRT_READ_TEMP_MIN (PMBUS_VIRT_BASE + 1) 151 #define PMBUS_VIRT_READ_TEMP_MAX (PMBUS_VIRT_BASE + 2) 152 #define PMBUS_VIRT_RESET_TEMP_HISTORY (PMBUS_VIRT_BASE + 3) 153 #define PMBUS_VIRT_READ_VIN_AVG (PMBUS_VIRT_BASE + 4) 154 #define PMBUS_VIRT_READ_VIN_MIN (PMBUS_VIRT_BASE + 5) 155 #define PMBUS_VIRT_READ_VIN_MAX (PMBUS_VIRT_BASE + 6) 156 #define PMBUS_VIRT_RESET_VIN_HISTORY (PMBUS_VIRT_BASE + 7) 157 #define PMBUS_VIRT_READ_IIN_AVG (PMBUS_VIRT_BASE + 8) 158 #define PMBUS_VIRT_READ_IIN_MIN (PMBUS_VIRT_BASE + 9) 159 #define PMBUS_VIRT_READ_IIN_MAX (PMBUS_VIRT_BASE + 10) 160 #define PMBUS_VIRT_RESET_IIN_HISTORY (PMBUS_VIRT_BASE + 11) 161 #define PMBUS_VIRT_READ_PIN_AVG (PMBUS_VIRT_BASE + 12) 162 #define PMBUS_VIRT_READ_PIN_MAX (PMBUS_VIRT_BASE + 13) 163 #define PMBUS_VIRT_RESET_PIN_HISTORY (PMBUS_VIRT_BASE + 14) 164 #define PMBUS_VIRT_READ_POUT_AVG (PMBUS_VIRT_BASE + 15) 165 #define PMBUS_VIRT_READ_POUT_MAX (PMBUS_VIRT_BASE + 16) 166 #define PMBUS_VIRT_RESET_POUT_HISTORY (PMBUS_VIRT_BASE + 17) 167 #define PMBUS_VIRT_READ_VOUT_AVG (PMBUS_VIRT_BASE + 18) 168 #define PMBUS_VIRT_READ_VOUT_MIN (PMBUS_VIRT_BASE + 19) 169 #define PMBUS_VIRT_READ_VOUT_MAX (PMBUS_VIRT_BASE + 20) 170 #define PMBUS_VIRT_RESET_VOUT_HISTORY (PMBUS_VIRT_BASE + 21) 171 #define PMBUS_VIRT_READ_IOUT_AVG (PMBUS_VIRT_BASE + 22) 172 #define PMBUS_VIRT_READ_IOUT_MIN (PMBUS_VIRT_BASE + 23) 173 #define PMBUS_VIRT_READ_IOUT_MAX (PMBUS_VIRT_BASE + 24) 174 #define PMBUS_VIRT_RESET_IOUT_HISTORY (PMBUS_VIRT_BASE + 25) 175 #define PMBUS_VIRT_READ_TEMP2_AVG (PMBUS_VIRT_BASE + 26) 176 #define PMBUS_VIRT_READ_TEMP2_MIN (PMBUS_VIRT_BASE + 27) 177 #define PMBUS_VIRT_READ_TEMP2_MAX (PMBUS_VIRT_BASE + 28) 178 #define PMBUS_VIRT_RESET_TEMP2_HISTORY (PMBUS_VIRT_BASE + 29) 179 180 /* 181 * CAPABILITY 182 */ 183 #define PB_CAPABILITY_SMBALERT (1<<4) 184 #define PB_CAPABILITY_ERROR_CHECK (1<<7) 185 186 /* 187 * VOUT_MODE 188 */ 189 #define PB_VOUT_MODE_MODE_MASK 0xe0 190 #define PB_VOUT_MODE_PARAM_MASK 0x1f 191 192 #define PB_VOUT_MODE_LINEAR 0x00 193 #define PB_VOUT_MODE_VID 0x20 194 #define PB_VOUT_MODE_DIRECT 0x40 195 196 /* 197 * Fan configuration 198 */ 199 #define PB_FAN_2_PULSE_MASK ((1 << 0) | (1 << 1)) 200 #define PB_FAN_2_RPM (1 << 2) 201 #define PB_FAN_2_INSTALLED (1 << 3) 202 #define PB_FAN_1_PULSE_MASK ((1 << 4) | (1 << 5)) 203 #define PB_FAN_1_RPM (1 << 6) 204 #define PB_FAN_1_INSTALLED (1 << 7) 205 206 /* 207 * STATUS_BYTE, STATUS_WORD (lower) 208 */ 209 #define PB_STATUS_NONE_ABOVE (1<<0) 210 #define PB_STATUS_CML (1<<1) 211 #define PB_STATUS_TEMPERATURE (1<<2) 212 #define PB_STATUS_VIN_UV (1<<3) 213 #define PB_STATUS_IOUT_OC (1<<4) 214 #define PB_STATUS_VOUT_OV (1<<5) 215 #define PB_STATUS_OFF (1<<6) 216 #define PB_STATUS_BUSY (1<<7) 217 218 /* 219 * STATUS_WORD (upper) 220 */ 221 #define PB_STATUS_UNKNOWN (1<<8) 222 #define PB_STATUS_OTHER (1<<9) 223 #define PB_STATUS_FANS (1<<10) 224 #define PB_STATUS_POWER_GOOD_N (1<<11) 225 #define PB_STATUS_WORD_MFR (1<<12) 226 #define PB_STATUS_INPUT (1<<13) 227 #define PB_STATUS_IOUT_POUT (1<<14) 228 #define PB_STATUS_VOUT (1<<15) 229 230 /* 231 * STATUS_IOUT 232 */ 233 #define PB_POUT_OP_WARNING (1<<0) 234 #define PB_POUT_OP_FAULT (1<<1) 235 #define PB_POWER_LIMITING (1<<2) 236 #define PB_CURRENT_SHARE_FAULT (1<<3) 237 #define PB_IOUT_UC_FAULT (1<<4) 238 #define PB_IOUT_OC_WARNING (1<<5) 239 #define PB_IOUT_OC_LV_FAULT (1<<6) 240 #define PB_IOUT_OC_FAULT (1<<7) 241 242 /* 243 * STATUS_VOUT, STATUS_INPUT 244 */ 245 #define PB_VOLTAGE_UV_FAULT (1<<4) 246 #define PB_VOLTAGE_UV_WARNING (1<<5) 247 #define PB_VOLTAGE_OV_WARNING (1<<6) 248 #define PB_VOLTAGE_OV_FAULT (1<<7) 249 250 /* 251 * STATUS_INPUT 252 */ 253 #define PB_PIN_OP_WARNING (1<<0) 254 #define PB_IIN_OC_WARNING (1<<1) 255 #define PB_IIN_OC_FAULT (1<<2) 256 257 /* 258 * STATUS_TEMPERATURE 259 */ 260 #define PB_TEMP_UT_FAULT (1<<4) 261 #define PB_TEMP_UT_WARNING (1<<5) 262 #define PB_TEMP_OT_WARNING (1<<6) 263 #define PB_TEMP_OT_FAULT (1<<7) 264 265 /* 266 * STATUS_FAN 267 */ 268 #define PB_FAN_AIRFLOW_WARNING (1<<0) 269 #define PB_FAN_AIRFLOW_FAULT (1<<1) 270 #define PB_FAN_FAN2_SPEED_OVERRIDE (1<<2) 271 #define PB_FAN_FAN1_SPEED_OVERRIDE (1<<3) 272 #define PB_FAN_FAN2_WARNING (1<<4) 273 #define PB_FAN_FAN1_WARNING (1<<5) 274 #define PB_FAN_FAN2_FAULT (1<<6) 275 #define PB_FAN_FAN1_FAULT (1<<7) 276 277 /* 278 * CML_FAULT_STATUS 279 */ 280 #define PB_CML_FAULT_OTHER_MEM_LOGIC (1<<0) 281 #define PB_CML_FAULT_OTHER_COMM (1<<1) 282 #define PB_CML_FAULT_PROCESSOR (1<<3) 283 #define PB_CML_FAULT_MEMORY (1<<4) 284 #define PB_CML_FAULT_PACKET_ERROR (1<<5) 285 #define PB_CML_FAULT_INVALID_DATA (1<<6) 286 #define PB_CML_FAULT_INVALID_COMMAND (1<<7) 287 288 enum pmbus_sensor_classes { 289 PSC_VOLTAGE_IN = 0, 290 PSC_VOLTAGE_OUT, 291 PSC_CURRENT_IN, 292 PSC_CURRENT_OUT, 293 PSC_POWER, 294 PSC_TEMPERATURE, 295 PSC_FAN, 296 PSC_NUM_CLASSES /* Number of power sensor classes */ 297 }; 298 299 #define PMBUS_PAGES 32 /* Per PMBus specification */ 300 301 /* Functionality bit mask */ 302 #define PMBUS_HAVE_VIN (1 << 0) 303 #define PMBUS_HAVE_VCAP (1 << 1) 304 #define PMBUS_HAVE_VOUT (1 << 2) 305 #define PMBUS_HAVE_IIN (1 << 3) 306 #define PMBUS_HAVE_IOUT (1 << 4) 307 #define PMBUS_HAVE_PIN (1 << 5) 308 #define PMBUS_HAVE_POUT (1 << 6) 309 #define PMBUS_HAVE_FAN12 (1 << 7) 310 #define PMBUS_HAVE_FAN34 (1 << 8) 311 #define PMBUS_HAVE_TEMP (1 << 9) 312 #define PMBUS_HAVE_TEMP2 (1 << 10) 313 #define PMBUS_HAVE_TEMP3 (1 << 11) 314 #define PMBUS_HAVE_STATUS_VOUT (1 << 12) 315 #define PMBUS_HAVE_STATUS_IOUT (1 << 13) 316 #define PMBUS_HAVE_STATUS_INPUT (1 << 14) 317 #define PMBUS_HAVE_STATUS_TEMP (1 << 15) 318 #define PMBUS_HAVE_STATUS_FAN12 (1 << 16) 319 #define PMBUS_HAVE_STATUS_FAN34 (1 << 17) 320 321 enum pmbus_data_format { linear = 0, direct, vid }; 322 323 struct pmbus_driver_info { 324 int pages; /* Total number of pages */ 325 enum pmbus_data_format format[PSC_NUM_CLASSES]; 326 /* 327 * Support one set of coefficients for each sensor type 328 * Used for chips providing data in direct mode. 329 */ 330 int m[PSC_NUM_CLASSES]; /* mantissa for direct data format */ 331 int b[PSC_NUM_CLASSES]; /* offset */ 332 int R[PSC_NUM_CLASSES]; /* exponent */ 333 334 u32 func[PMBUS_PAGES]; /* Functionality, per page */ 335 /* 336 * The following functions map manufacturing specific register values 337 * to PMBus standard register values. Specify only if mapping is 338 * necessary. 339 * Functions return the register value (read) or zero (write) if 340 * successful. A return value of -ENODATA indicates that there is no 341 * manufacturer specific register, but that a standard PMBus register 342 * may exist. Any other negative return value indicates that the 343 * register does not exist, and that no attempt should be made to read 344 * the standard register. 345 */ 346 int (*read_byte_data)(struct i2c_client *client, int page, int reg); 347 int (*read_word_data)(struct i2c_client *client, int page, int reg); 348 int (*write_word_data)(struct i2c_client *client, int page, int reg, 349 u16 word); 350 int (*write_byte)(struct i2c_client *client, int page, u8 value); 351 /* 352 * The identify function determines supported PMBus functionality. 353 * This function is only necessary if a chip driver supports multiple 354 * chips, and the chip functionality is not pre-determined. 355 */ 356 int (*identify)(struct i2c_client *client, 357 struct pmbus_driver_info *info); 358 }; 359 360 /* Function declarations */ 361 362 int pmbus_set_page(struct i2c_client *client, u8 page); 363 int pmbus_read_word_data(struct i2c_client *client, u8 page, u8 reg); 364 int pmbus_write_word_data(struct i2c_client *client, u8 page, u8 reg, u16 word); 365 int pmbus_read_byte_data(struct i2c_client *client, int page, u8 reg); 366 int pmbus_write_byte(struct i2c_client *client, int page, u8 value); 367 void pmbus_clear_faults(struct i2c_client *client); 368 bool pmbus_check_byte_register(struct i2c_client *client, int page, int reg); 369 bool pmbus_check_word_register(struct i2c_client *client, int page, int reg); 370 int pmbus_do_probe(struct i2c_client *client, const struct i2c_device_id *id, 371 struct pmbus_driver_info *info); 372 int pmbus_do_remove(struct i2c_client *client); 373 const struct pmbus_driver_info *pmbus_get_driver_info(struct i2c_client 374 *client); 375 376 #endif /* PMBUS_H */ 377