19d2ecfb7SGuenter Roeck /* 29d2ecfb7SGuenter Roeck * pmbus.h - Common defines and structures for PMBus devices 39d2ecfb7SGuenter Roeck * 49d2ecfb7SGuenter Roeck * Copyright (c) 2010, 2011 Ericsson AB. 5aebcbbfcSGuenter Roeck * Copyright (c) 2012 Guenter Roeck 69d2ecfb7SGuenter Roeck * 79d2ecfb7SGuenter Roeck * This program is free software; you can redistribute it and/or modify 89d2ecfb7SGuenter Roeck * it under the terms of the GNU General Public License as published by 99d2ecfb7SGuenter Roeck * the Free Software Foundation; either version 2 of the License, or 109d2ecfb7SGuenter Roeck * (at your option) any later version. 119d2ecfb7SGuenter Roeck * 129d2ecfb7SGuenter Roeck * This program is distributed in the hope that it will be useful, 139d2ecfb7SGuenter Roeck * but WITHOUT ANY WARRANTY; without even the implied warranty of 149d2ecfb7SGuenter Roeck * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 159d2ecfb7SGuenter Roeck * GNU General Public License for more details. 169d2ecfb7SGuenter Roeck * 179d2ecfb7SGuenter Roeck * You should have received a copy of the GNU General Public License 189d2ecfb7SGuenter Roeck * along with this program; if not, write to the Free Software 199d2ecfb7SGuenter Roeck * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 209d2ecfb7SGuenter Roeck */ 219d2ecfb7SGuenter Roeck 229d2ecfb7SGuenter Roeck #ifndef PMBUS_H 239d2ecfb7SGuenter Roeck #define PMBUS_H 249d2ecfb7SGuenter Roeck 25*2c052d42SGuenter Roeck #include <linux/bitops.h> 26*2c052d42SGuenter Roeck #include <linux/regulator/driver.h> 27*2c052d42SGuenter Roeck 289d2ecfb7SGuenter Roeck /* 299d2ecfb7SGuenter Roeck * Registers 309d2ecfb7SGuenter Roeck */ 312238835cSGuenter Roeck enum pmbus_regs { 322238835cSGuenter Roeck PMBUS_PAGE = 0x00, 332238835cSGuenter Roeck PMBUS_OPERATION = 0x01, 342238835cSGuenter Roeck PMBUS_ON_OFF_CONFIG = 0x02, 352238835cSGuenter Roeck PMBUS_CLEAR_FAULTS = 0x03, 362238835cSGuenter Roeck PMBUS_PHASE = 0x04, 379d2ecfb7SGuenter Roeck 382238835cSGuenter Roeck PMBUS_CAPABILITY = 0x19, 392238835cSGuenter Roeck PMBUS_QUERY = 0x1A, 409d2ecfb7SGuenter Roeck 412238835cSGuenter Roeck PMBUS_VOUT_MODE = 0x20, 422238835cSGuenter Roeck PMBUS_VOUT_COMMAND = 0x21, 432238835cSGuenter Roeck PMBUS_VOUT_TRIM = 0x22, 442238835cSGuenter Roeck PMBUS_VOUT_CAL_OFFSET = 0x23, 452238835cSGuenter Roeck PMBUS_VOUT_MAX = 0x24, 462238835cSGuenter Roeck PMBUS_VOUT_MARGIN_HIGH = 0x25, 472238835cSGuenter Roeck PMBUS_VOUT_MARGIN_LOW = 0x26, 482238835cSGuenter Roeck PMBUS_VOUT_TRANSITION_RATE = 0x27, 492238835cSGuenter Roeck PMBUS_VOUT_DROOP = 0x28, 502238835cSGuenter Roeck PMBUS_VOUT_SCALE_LOOP = 0x29, 512238835cSGuenter Roeck PMBUS_VOUT_SCALE_MONITOR = 0x2A, 529d2ecfb7SGuenter Roeck 532238835cSGuenter Roeck PMBUS_COEFFICIENTS = 0x30, 542238835cSGuenter Roeck PMBUS_POUT_MAX = 0x31, 559d2ecfb7SGuenter Roeck 562238835cSGuenter Roeck PMBUS_FAN_CONFIG_12 = 0x3A, 572238835cSGuenter Roeck PMBUS_FAN_COMMAND_1 = 0x3B, 582238835cSGuenter Roeck PMBUS_FAN_COMMAND_2 = 0x3C, 592238835cSGuenter Roeck PMBUS_FAN_CONFIG_34 = 0x3D, 602238835cSGuenter Roeck PMBUS_FAN_COMMAND_3 = 0x3E, 612238835cSGuenter Roeck PMBUS_FAN_COMMAND_4 = 0x3F, 629d2ecfb7SGuenter Roeck 632238835cSGuenter Roeck PMBUS_VOUT_OV_FAULT_LIMIT = 0x40, 642238835cSGuenter Roeck PMBUS_VOUT_OV_FAULT_RESPONSE = 0x41, 652238835cSGuenter Roeck PMBUS_VOUT_OV_WARN_LIMIT = 0x42, 662238835cSGuenter Roeck PMBUS_VOUT_UV_WARN_LIMIT = 0x43, 672238835cSGuenter Roeck PMBUS_VOUT_UV_FAULT_LIMIT = 0x44, 682238835cSGuenter Roeck PMBUS_VOUT_UV_FAULT_RESPONSE = 0x45, 692238835cSGuenter Roeck PMBUS_IOUT_OC_FAULT_LIMIT = 0x46, 702238835cSGuenter Roeck PMBUS_IOUT_OC_FAULT_RESPONSE = 0x47, 712238835cSGuenter Roeck PMBUS_IOUT_OC_LV_FAULT_LIMIT = 0x48, 722238835cSGuenter Roeck PMBUS_IOUT_OC_LV_FAULT_RESPONSE = 0x49, 732238835cSGuenter Roeck PMBUS_IOUT_OC_WARN_LIMIT = 0x4A, 742238835cSGuenter Roeck PMBUS_IOUT_UC_FAULT_LIMIT = 0x4B, 752238835cSGuenter Roeck PMBUS_IOUT_UC_FAULT_RESPONSE = 0x4C, 769d2ecfb7SGuenter Roeck 772238835cSGuenter Roeck PMBUS_OT_FAULT_LIMIT = 0x4F, 782238835cSGuenter Roeck PMBUS_OT_FAULT_RESPONSE = 0x50, 792238835cSGuenter Roeck PMBUS_OT_WARN_LIMIT = 0x51, 802238835cSGuenter Roeck PMBUS_UT_WARN_LIMIT = 0x52, 812238835cSGuenter Roeck PMBUS_UT_FAULT_LIMIT = 0x53, 822238835cSGuenter Roeck PMBUS_UT_FAULT_RESPONSE = 0x54, 832238835cSGuenter Roeck PMBUS_VIN_OV_FAULT_LIMIT = 0x55, 842238835cSGuenter Roeck PMBUS_VIN_OV_FAULT_RESPONSE = 0x56, 852238835cSGuenter Roeck PMBUS_VIN_OV_WARN_LIMIT = 0x57, 862238835cSGuenter Roeck PMBUS_VIN_UV_WARN_LIMIT = 0x58, 872238835cSGuenter Roeck PMBUS_VIN_UV_FAULT_LIMIT = 0x59, 889d2ecfb7SGuenter Roeck 892238835cSGuenter Roeck PMBUS_IIN_OC_FAULT_LIMIT = 0x5B, 902238835cSGuenter Roeck PMBUS_IIN_OC_WARN_LIMIT = 0x5D, 919d2ecfb7SGuenter Roeck 922238835cSGuenter Roeck PMBUS_POUT_OP_FAULT_LIMIT = 0x68, 932238835cSGuenter Roeck PMBUS_POUT_OP_WARN_LIMIT = 0x6A, 942238835cSGuenter Roeck PMBUS_PIN_OP_WARN_LIMIT = 0x6B, 959d2ecfb7SGuenter Roeck 962238835cSGuenter Roeck PMBUS_STATUS_BYTE = 0x78, 972238835cSGuenter Roeck PMBUS_STATUS_WORD = 0x79, 982238835cSGuenter Roeck PMBUS_STATUS_VOUT = 0x7A, 992238835cSGuenter Roeck PMBUS_STATUS_IOUT = 0x7B, 1002238835cSGuenter Roeck PMBUS_STATUS_INPUT = 0x7C, 1012238835cSGuenter Roeck PMBUS_STATUS_TEMPERATURE = 0x7D, 1022238835cSGuenter Roeck PMBUS_STATUS_CML = 0x7E, 1032238835cSGuenter Roeck PMBUS_STATUS_OTHER = 0x7F, 1042238835cSGuenter Roeck PMBUS_STATUS_MFR_SPECIFIC = 0x80, 1052238835cSGuenter Roeck PMBUS_STATUS_FAN_12 = 0x81, 1062238835cSGuenter Roeck PMBUS_STATUS_FAN_34 = 0x82, 1079d2ecfb7SGuenter Roeck 1082238835cSGuenter Roeck PMBUS_READ_VIN = 0x88, 1092238835cSGuenter Roeck PMBUS_READ_IIN = 0x89, 1102238835cSGuenter Roeck PMBUS_READ_VCAP = 0x8A, 1112238835cSGuenter Roeck PMBUS_READ_VOUT = 0x8B, 1122238835cSGuenter Roeck PMBUS_READ_IOUT = 0x8C, 1132238835cSGuenter Roeck PMBUS_READ_TEMPERATURE_1 = 0x8D, 1142238835cSGuenter Roeck PMBUS_READ_TEMPERATURE_2 = 0x8E, 1152238835cSGuenter Roeck PMBUS_READ_TEMPERATURE_3 = 0x8F, 1162238835cSGuenter Roeck PMBUS_READ_FAN_SPEED_1 = 0x90, 1172238835cSGuenter Roeck PMBUS_READ_FAN_SPEED_2 = 0x91, 1182238835cSGuenter Roeck PMBUS_READ_FAN_SPEED_3 = 0x92, 1192238835cSGuenter Roeck PMBUS_READ_FAN_SPEED_4 = 0x93, 1202238835cSGuenter Roeck PMBUS_READ_DUTY_CYCLE = 0x94, 1212238835cSGuenter Roeck PMBUS_READ_FREQUENCY = 0x95, 1222238835cSGuenter Roeck PMBUS_READ_POUT = 0x96, 1232238835cSGuenter Roeck PMBUS_READ_PIN = 0x97, 1249d2ecfb7SGuenter Roeck 1252238835cSGuenter Roeck PMBUS_REVISION = 0x98, 1262238835cSGuenter Roeck PMBUS_MFR_ID = 0x99, 1272238835cSGuenter Roeck PMBUS_MFR_MODEL = 0x9A, 1282238835cSGuenter Roeck PMBUS_MFR_REVISION = 0x9B, 1292238835cSGuenter Roeck PMBUS_MFR_LOCATION = 0x9C, 1302238835cSGuenter Roeck PMBUS_MFR_DATE = 0x9D, 1312238835cSGuenter Roeck PMBUS_MFR_SERIAL = 0x9E, 1329d2ecfb7SGuenter Roeck 1339d2ecfb7SGuenter Roeck /* 1346f183d33SGuenter Roeck * Virtual registers. 1356f183d33SGuenter Roeck * Useful to support attributes which are not supported by standard PMBus 1366f183d33SGuenter Roeck * registers but exist as manufacturer specific registers on individual chips. 1376f183d33SGuenter Roeck * Must be mapped to real registers in device specific code. 1386f183d33SGuenter Roeck * 1396f183d33SGuenter Roeck * Semantics: 1406f183d33SGuenter Roeck * Virtual registers are all word size. 1416f183d33SGuenter Roeck * READ registers are read-only; writes are either ignored or return an error. 14220fcfe17SGuenter Roeck * RESET registers are read/write. Reading reset registers returns zero 14320fcfe17SGuenter Roeck * (used for detection), writing any value causes the associated history to be 14420fcfe17SGuenter Roeck * reset. 14520fcfe17SGuenter Roeck * Virtual registers have to be handled in device specific driver code. Chip 14620fcfe17SGuenter Roeck * driver code returns non-negative register values if a virtual register is 14720fcfe17SGuenter Roeck * supported, or a negative error code if not. The chip driver may return 14820fcfe17SGuenter Roeck * -ENODATA or any other error code in this case, though an error code other 14920fcfe17SGuenter Roeck * than -ENODATA is handled more efficiently and thus preferred. Either case, 15020fcfe17SGuenter Roeck * the calling PMBus core code will abort if the chip driver returns an error 15120fcfe17SGuenter Roeck * code when reading or writing virtual registers. 1526f183d33SGuenter Roeck */ 1532238835cSGuenter Roeck PMBUS_VIRT_BASE = 0x100, 1542238835cSGuenter Roeck PMBUS_VIRT_READ_TEMP_AVG, 1552238835cSGuenter Roeck PMBUS_VIRT_READ_TEMP_MIN, 1562238835cSGuenter Roeck PMBUS_VIRT_READ_TEMP_MAX, 1572238835cSGuenter Roeck PMBUS_VIRT_RESET_TEMP_HISTORY, 1582238835cSGuenter Roeck PMBUS_VIRT_READ_VIN_AVG, 1592238835cSGuenter Roeck PMBUS_VIRT_READ_VIN_MIN, 1602238835cSGuenter Roeck PMBUS_VIRT_READ_VIN_MAX, 1612238835cSGuenter Roeck PMBUS_VIRT_RESET_VIN_HISTORY, 1622238835cSGuenter Roeck PMBUS_VIRT_READ_IIN_AVG, 1632238835cSGuenter Roeck PMBUS_VIRT_READ_IIN_MIN, 1642238835cSGuenter Roeck PMBUS_VIRT_READ_IIN_MAX, 1652238835cSGuenter Roeck PMBUS_VIRT_RESET_IIN_HISTORY, 1662238835cSGuenter Roeck PMBUS_VIRT_READ_PIN_AVG, 1672238835cSGuenter Roeck PMBUS_VIRT_READ_PIN_MIN, 1682238835cSGuenter Roeck PMBUS_VIRT_READ_PIN_MAX, 1692238835cSGuenter Roeck PMBUS_VIRT_RESET_PIN_HISTORY, 1702238835cSGuenter Roeck PMBUS_VIRT_READ_POUT_AVG, 1712238835cSGuenter Roeck PMBUS_VIRT_READ_POUT_MIN, 1722238835cSGuenter Roeck PMBUS_VIRT_READ_POUT_MAX, 1732238835cSGuenter Roeck PMBUS_VIRT_RESET_POUT_HISTORY, 1742238835cSGuenter Roeck PMBUS_VIRT_READ_VOUT_AVG, 1752238835cSGuenter Roeck PMBUS_VIRT_READ_VOUT_MIN, 1762238835cSGuenter Roeck PMBUS_VIRT_READ_VOUT_MAX, 1772238835cSGuenter Roeck PMBUS_VIRT_RESET_VOUT_HISTORY, 1782238835cSGuenter Roeck PMBUS_VIRT_READ_IOUT_AVG, 1792238835cSGuenter Roeck PMBUS_VIRT_READ_IOUT_MIN, 1802238835cSGuenter Roeck PMBUS_VIRT_READ_IOUT_MAX, 1812238835cSGuenter Roeck PMBUS_VIRT_RESET_IOUT_HISTORY, 1822238835cSGuenter Roeck PMBUS_VIRT_READ_TEMP2_AVG, 1832238835cSGuenter Roeck PMBUS_VIRT_READ_TEMP2_MIN, 1842238835cSGuenter Roeck PMBUS_VIRT_READ_TEMP2_MAX, 1852238835cSGuenter Roeck PMBUS_VIRT_RESET_TEMP2_HISTORY, 1866f183d33SGuenter Roeck 1872238835cSGuenter Roeck PMBUS_VIRT_READ_VMON, 1882238835cSGuenter Roeck PMBUS_VIRT_VMON_UV_WARN_LIMIT, 1892238835cSGuenter Roeck PMBUS_VIRT_VMON_OV_WARN_LIMIT, 1902238835cSGuenter Roeck PMBUS_VIRT_VMON_UV_FAULT_LIMIT, 1912238835cSGuenter Roeck PMBUS_VIRT_VMON_OV_FAULT_LIMIT, 1922238835cSGuenter Roeck PMBUS_VIRT_STATUS_VMON, 1932238835cSGuenter Roeck }; 194aebcbbfcSGuenter Roeck 1956f183d33SGuenter Roeck /* 196ddbb4db4SAlan Tull * OPERATION 197ddbb4db4SAlan Tull */ 198*2c052d42SGuenter Roeck #define PB_OPERATION_CONTROL_ON BIT(7) 199ddbb4db4SAlan Tull 200ddbb4db4SAlan Tull /* 2019d2ecfb7SGuenter Roeck * CAPABILITY 2029d2ecfb7SGuenter Roeck */ 203*2c052d42SGuenter Roeck #define PB_CAPABILITY_SMBALERT BIT(4) 204*2c052d42SGuenter Roeck #define PB_CAPABILITY_ERROR_CHECK BIT(7) 2059d2ecfb7SGuenter Roeck 2069d2ecfb7SGuenter Roeck /* 2079d2ecfb7SGuenter Roeck * VOUT_MODE 2089d2ecfb7SGuenter Roeck */ 2099d2ecfb7SGuenter Roeck #define PB_VOUT_MODE_MODE_MASK 0xe0 2109d2ecfb7SGuenter Roeck #define PB_VOUT_MODE_PARAM_MASK 0x1f 2119d2ecfb7SGuenter Roeck 2129d2ecfb7SGuenter Roeck #define PB_VOUT_MODE_LINEAR 0x00 2139d2ecfb7SGuenter Roeck #define PB_VOUT_MODE_VID 0x20 2149d2ecfb7SGuenter Roeck #define PB_VOUT_MODE_DIRECT 0x40 2159d2ecfb7SGuenter Roeck 2169d2ecfb7SGuenter Roeck /* 2179d2ecfb7SGuenter Roeck * Fan configuration 2189d2ecfb7SGuenter Roeck */ 219*2c052d42SGuenter Roeck #define PB_FAN_2_PULSE_MASK (BIT(0) | BIT(1)) 220*2c052d42SGuenter Roeck #define PB_FAN_2_RPM BIT(2) 221*2c052d42SGuenter Roeck #define PB_FAN_2_INSTALLED BIT(3) 222*2c052d42SGuenter Roeck #define PB_FAN_1_PULSE_MASK (BIT(4) | BIT(5)) 223*2c052d42SGuenter Roeck #define PB_FAN_1_RPM BIT(6) 224*2c052d42SGuenter Roeck #define PB_FAN_1_INSTALLED BIT(7) 2259d2ecfb7SGuenter Roeck 2269d2ecfb7SGuenter Roeck /* 2279d2ecfb7SGuenter Roeck * STATUS_BYTE, STATUS_WORD (lower) 2289d2ecfb7SGuenter Roeck */ 229*2c052d42SGuenter Roeck #define PB_STATUS_NONE_ABOVE BIT(0) 230*2c052d42SGuenter Roeck #define PB_STATUS_CML BIT(1) 231*2c052d42SGuenter Roeck #define PB_STATUS_TEMPERATURE BIT(2) 232*2c052d42SGuenter Roeck #define PB_STATUS_VIN_UV BIT(3) 233*2c052d42SGuenter Roeck #define PB_STATUS_IOUT_OC BIT(4) 234*2c052d42SGuenter Roeck #define PB_STATUS_VOUT_OV BIT(5) 235*2c052d42SGuenter Roeck #define PB_STATUS_OFF BIT(6) 236*2c052d42SGuenter Roeck #define PB_STATUS_BUSY BIT(7) 2379d2ecfb7SGuenter Roeck 2389d2ecfb7SGuenter Roeck /* 2399d2ecfb7SGuenter Roeck * STATUS_WORD (upper) 2409d2ecfb7SGuenter Roeck */ 241*2c052d42SGuenter Roeck #define PB_STATUS_UNKNOWN BIT(8) 242*2c052d42SGuenter Roeck #define PB_STATUS_OTHER BIT(9) 243*2c052d42SGuenter Roeck #define PB_STATUS_FANS BIT(10) 244*2c052d42SGuenter Roeck #define PB_STATUS_POWER_GOOD_N BIT(11) 245*2c052d42SGuenter Roeck #define PB_STATUS_WORD_MFR BIT(12) 246*2c052d42SGuenter Roeck #define PB_STATUS_INPUT BIT(13) 247*2c052d42SGuenter Roeck #define PB_STATUS_IOUT_POUT BIT(14) 248*2c052d42SGuenter Roeck #define PB_STATUS_VOUT BIT(15) 2499d2ecfb7SGuenter Roeck 2509d2ecfb7SGuenter Roeck /* 2519d2ecfb7SGuenter Roeck * STATUS_IOUT 2529d2ecfb7SGuenter Roeck */ 253*2c052d42SGuenter Roeck #define PB_POUT_OP_WARNING BIT(0) 254*2c052d42SGuenter Roeck #define PB_POUT_OP_FAULT BIT(1) 255*2c052d42SGuenter Roeck #define PB_POWER_LIMITING BIT(2) 256*2c052d42SGuenter Roeck #define PB_CURRENT_SHARE_FAULT BIT(3) 257*2c052d42SGuenter Roeck #define PB_IOUT_UC_FAULT BIT(4) 258*2c052d42SGuenter Roeck #define PB_IOUT_OC_WARNING BIT(5) 259*2c052d42SGuenter Roeck #define PB_IOUT_OC_LV_FAULT BIT(6) 260*2c052d42SGuenter Roeck #define PB_IOUT_OC_FAULT BIT(7) 2619d2ecfb7SGuenter Roeck 2629d2ecfb7SGuenter Roeck /* 2639d2ecfb7SGuenter Roeck * STATUS_VOUT, STATUS_INPUT 2649d2ecfb7SGuenter Roeck */ 265*2c052d42SGuenter Roeck #define PB_VOLTAGE_UV_FAULT BIT(4) 266*2c052d42SGuenter Roeck #define PB_VOLTAGE_UV_WARNING BIT(5) 267*2c052d42SGuenter Roeck #define PB_VOLTAGE_OV_WARNING BIT(6) 268*2c052d42SGuenter Roeck #define PB_VOLTAGE_OV_FAULT BIT(7) 2699d2ecfb7SGuenter Roeck 2709d2ecfb7SGuenter Roeck /* 2719d2ecfb7SGuenter Roeck * STATUS_INPUT 2729d2ecfb7SGuenter Roeck */ 273*2c052d42SGuenter Roeck #define PB_PIN_OP_WARNING BIT(0) 274*2c052d42SGuenter Roeck #define PB_IIN_OC_WARNING BIT(1) 275*2c052d42SGuenter Roeck #define PB_IIN_OC_FAULT BIT(2) 2769d2ecfb7SGuenter Roeck 2779d2ecfb7SGuenter Roeck /* 2789d2ecfb7SGuenter Roeck * STATUS_TEMPERATURE 2799d2ecfb7SGuenter Roeck */ 280*2c052d42SGuenter Roeck #define PB_TEMP_UT_FAULT BIT(4) 281*2c052d42SGuenter Roeck #define PB_TEMP_UT_WARNING BIT(5) 282*2c052d42SGuenter Roeck #define PB_TEMP_OT_WARNING BIT(6) 283*2c052d42SGuenter Roeck #define PB_TEMP_OT_FAULT BIT(7) 2849d2ecfb7SGuenter Roeck 2859d2ecfb7SGuenter Roeck /* 2869d2ecfb7SGuenter Roeck * STATUS_FAN 2879d2ecfb7SGuenter Roeck */ 288*2c052d42SGuenter Roeck #define PB_FAN_AIRFLOW_WARNING BIT(0) 289*2c052d42SGuenter Roeck #define PB_FAN_AIRFLOW_FAULT BIT(1) 290*2c052d42SGuenter Roeck #define PB_FAN_FAN2_SPEED_OVERRIDE BIT(2) 291*2c052d42SGuenter Roeck #define PB_FAN_FAN1_SPEED_OVERRIDE BIT(3) 292*2c052d42SGuenter Roeck #define PB_FAN_FAN2_WARNING BIT(4) 293*2c052d42SGuenter Roeck #define PB_FAN_FAN1_WARNING BIT(5) 294*2c052d42SGuenter Roeck #define PB_FAN_FAN2_FAULT BIT(6) 295*2c052d42SGuenter Roeck #define PB_FAN_FAN1_FAULT BIT(7) 2969d2ecfb7SGuenter Roeck 2979d2ecfb7SGuenter Roeck /* 2989d2ecfb7SGuenter Roeck * CML_FAULT_STATUS 2999d2ecfb7SGuenter Roeck */ 300*2c052d42SGuenter Roeck #define PB_CML_FAULT_OTHER_MEM_LOGIC BIT(0) 301*2c052d42SGuenter Roeck #define PB_CML_FAULT_OTHER_COMM BIT(1) 302*2c052d42SGuenter Roeck #define PB_CML_FAULT_PROCESSOR BIT(3) 303*2c052d42SGuenter Roeck #define PB_CML_FAULT_MEMORY BIT(4) 304*2c052d42SGuenter Roeck #define PB_CML_FAULT_PACKET_ERROR BIT(5) 305*2c052d42SGuenter Roeck #define PB_CML_FAULT_INVALID_DATA BIT(6) 306*2c052d42SGuenter Roeck #define PB_CML_FAULT_INVALID_COMMAND BIT(7) 3079d2ecfb7SGuenter Roeck 3089d2ecfb7SGuenter Roeck enum pmbus_sensor_classes { 3099d2ecfb7SGuenter Roeck PSC_VOLTAGE_IN = 0, 3109d2ecfb7SGuenter Roeck PSC_VOLTAGE_OUT, 3119d2ecfb7SGuenter Roeck PSC_CURRENT_IN, 3129d2ecfb7SGuenter Roeck PSC_CURRENT_OUT, 3139d2ecfb7SGuenter Roeck PSC_POWER, 3149d2ecfb7SGuenter Roeck PSC_TEMPERATURE, 3159d2ecfb7SGuenter Roeck PSC_FAN, 3169d2ecfb7SGuenter Roeck PSC_NUM_CLASSES /* Number of power sensor classes */ 3179d2ecfb7SGuenter Roeck }; 3189d2ecfb7SGuenter Roeck 3199d2ecfb7SGuenter Roeck #define PMBUS_PAGES 32 /* Per PMBus specification */ 3209d2ecfb7SGuenter Roeck 3219d2ecfb7SGuenter Roeck /* Functionality bit mask */ 322*2c052d42SGuenter Roeck #define PMBUS_HAVE_VIN BIT(0) 323*2c052d42SGuenter Roeck #define PMBUS_HAVE_VCAP BIT(1) 324*2c052d42SGuenter Roeck #define PMBUS_HAVE_VOUT BIT(2) 325*2c052d42SGuenter Roeck #define PMBUS_HAVE_IIN BIT(3) 326*2c052d42SGuenter Roeck #define PMBUS_HAVE_IOUT BIT(4) 327*2c052d42SGuenter Roeck #define PMBUS_HAVE_PIN BIT(5) 328*2c052d42SGuenter Roeck #define PMBUS_HAVE_POUT BIT(6) 329*2c052d42SGuenter Roeck #define PMBUS_HAVE_FAN12 BIT(7) 330*2c052d42SGuenter Roeck #define PMBUS_HAVE_FAN34 BIT(8) 331*2c052d42SGuenter Roeck #define PMBUS_HAVE_TEMP BIT(9) 332*2c052d42SGuenter Roeck #define PMBUS_HAVE_TEMP2 BIT(10) 333*2c052d42SGuenter Roeck #define PMBUS_HAVE_TEMP3 BIT(11) 334*2c052d42SGuenter Roeck #define PMBUS_HAVE_STATUS_VOUT BIT(12) 335*2c052d42SGuenter Roeck #define PMBUS_HAVE_STATUS_IOUT BIT(13) 336*2c052d42SGuenter Roeck #define PMBUS_HAVE_STATUS_INPUT BIT(14) 337*2c052d42SGuenter Roeck #define PMBUS_HAVE_STATUS_TEMP BIT(15) 338*2c052d42SGuenter Roeck #define PMBUS_HAVE_STATUS_FAN12 BIT(16) 339*2c052d42SGuenter Roeck #define PMBUS_HAVE_STATUS_FAN34 BIT(17) 340*2c052d42SGuenter Roeck #define PMBUS_HAVE_VMON BIT(18) 341*2c052d42SGuenter Roeck #define PMBUS_HAVE_STATUS_VMON BIT(19) 3429d2ecfb7SGuenter Roeck 3431061d851SGuenter Roeck enum pmbus_data_format { linear = 0, direct, vid }; 344068c2270SGuenter Roeck enum vrm_version { vr11 = 0, vr12 }; 3451061d851SGuenter Roeck 3469d2ecfb7SGuenter Roeck struct pmbus_driver_info { 3479d2ecfb7SGuenter Roeck int pages; /* Total number of pages */ 3481061d851SGuenter Roeck enum pmbus_data_format format[PSC_NUM_CLASSES]; 349068c2270SGuenter Roeck enum vrm_version vrm_version; 3509d2ecfb7SGuenter Roeck /* 3519d2ecfb7SGuenter Roeck * Support one set of coefficients for each sensor type 3529d2ecfb7SGuenter Roeck * Used for chips providing data in direct mode. 3539d2ecfb7SGuenter Roeck */ 3549d2ecfb7SGuenter Roeck int m[PSC_NUM_CLASSES]; /* mantissa for direct data format */ 3559d2ecfb7SGuenter Roeck int b[PSC_NUM_CLASSES]; /* offset */ 3569d2ecfb7SGuenter Roeck int R[PSC_NUM_CLASSES]; /* exponent */ 3579d2ecfb7SGuenter Roeck 3589d2ecfb7SGuenter Roeck u32 func[PMBUS_PAGES]; /* Functionality, per page */ 3599d2ecfb7SGuenter Roeck /* 3609d2ecfb7SGuenter Roeck * The following functions map manufacturing specific register values 3619d2ecfb7SGuenter Roeck * to PMBus standard register values. Specify only if mapping is 3629d2ecfb7SGuenter Roeck * necessary. 36320fcfe17SGuenter Roeck * Functions return the register value (read) or zero (write) if 36420fcfe17SGuenter Roeck * successful. A return value of -ENODATA indicates that there is no 36520fcfe17SGuenter Roeck * manufacturer specific register, but that a standard PMBus register 36620fcfe17SGuenter Roeck * may exist. Any other negative return value indicates that the 36720fcfe17SGuenter Roeck * register does not exist, and that no attempt should be made to read 36820fcfe17SGuenter Roeck * the standard register. 3699d2ecfb7SGuenter Roeck */ 3709d2ecfb7SGuenter Roeck int (*read_byte_data)(struct i2c_client *client, int page, int reg); 37146243f3aSGuenter Roeck int (*read_word_data)(struct i2c_client *client, int page, int reg); 37246243f3aSGuenter Roeck int (*write_word_data)(struct i2c_client *client, int page, int reg, 37346243f3aSGuenter Roeck u16 word); 374044cd3a5SGuenter Roeck int (*write_byte)(struct i2c_client *client, int page, u8 value); 3759d2ecfb7SGuenter Roeck /* 3769d2ecfb7SGuenter Roeck * The identify function determines supported PMBus functionality. 3779d2ecfb7SGuenter Roeck * This function is only necessary if a chip driver supports multiple 3789d2ecfb7SGuenter Roeck * chips, and the chip functionality is not pre-determined. 3799d2ecfb7SGuenter Roeck */ 3809d2ecfb7SGuenter Roeck int (*identify)(struct i2c_client *client, 3819d2ecfb7SGuenter Roeck struct pmbus_driver_info *info); 382ddbb4db4SAlan Tull 383ddbb4db4SAlan Tull /* Regulator functionality, if supported by this chip driver. */ 384ddbb4db4SAlan Tull int num_regulators; 385ddbb4db4SAlan Tull const struct regulator_desc *reg_desc; 3869d2ecfb7SGuenter Roeck }; 3879d2ecfb7SGuenter Roeck 388ddbb4db4SAlan Tull /* Regulator ops */ 389ddbb4db4SAlan Tull 390a07d7311SAxel Lin extern const struct regulator_ops pmbus_regulator_ops; 391ddbb4db4SAlan Tull 392ddbb4db4SAlan Tull /* Macro for filling in array of struct regulator_desc */ 393ddbb4db4SAlan Tull #define PMBUS_REGULATOR(_name, _id) \ 394ddbb4db4SAlan Tull [_id] = { \ 395ddbb4db4SAlan Tull .name = (_name # _id), \ 396ddbb4db4SAlan Tull .id = (_id), \ 397ddbb4db4SAlan Tull .of_match = of_match_ptr(_name # _id), \ 398ddbb4db4SAlan Tull .regulators_node = of_match_ptr("regulators"), \ 399ddbb4db4SAlan Tull .ops = &pmbus_regulator_ops, \ 4007b7a8b42SAxel Lin .type = REGULATOR_VOLTAGE, \ 401ddbb4db4SAlan Tull .owner = THIS_MODULE, \ 402ddbb4db4SAlan Tull } 403ddbb4db4SAlan Tull 4049d2ecfb7SGuenter Roeck /* Function declarations */ 4059d2ecfb7SGuenter Roeck 406ce603b18SGuenter Roeck void pmbus_clear_cache(struct i2c_client *client); 4079d2ecfb7SGuenter Roeck int pmbus_set_page(struct i2c_client *client, u8 page); 4089d2ecfb7SGuenter Roeck int pmbus_read_word_data(struct i2c_client *client, u8 page, u8 reg); 40946243f3aSGuenter Roeck int pmbus_write_word_data(struct i2c_client *client, u8 page, u8 reg, u16 word); 4109c1ed894SGuenter Roeck int pmbus_read_byte_data(struct i2c_client *client, int page, u8 reg); 41103e9bd8dSGuenter Roeck int pmbus_write_byte(struct i2c_client *client, int page, u8 value); 41211c11998SAlan Tull int pmbus_write_byte_data(struct i2c_client *client, int page, u8 reg, 41311c11998SAlan Tull u8 value); 41411c11998SAlan Tull int pmbus_update_byte_data(struct i2c_client *client, int page, u8 reg, 41511c11998SAlan Tull u8 mask, u8 value); 4169d2ecfb7SGuenter Roeck void pmbus_clear_faults(struct i2c_client *client); 4179d2ecfb7SGuenter Roeck bool pmbus_check_byte_register(struct i2c_client *client, int page, int reg); 4189d2ecfb7SGuenter Roeck bool pmbus_check_word_register(struct i2c_client *client, int page, int reg); 4199d2ecfb7SGuenter Roeck int pmbus_do_probe(struct i2c_client *client, const struct i2c_device_id *id, 4209d2ecfb7SGuenter Roeck struct pmbus_driver_info *info); 421dd285ad7SGuenter Roeck int pmbus_do_remove(struct i2c_client *client); 4229d2ecfb7SGuenter Roeck const struct pmbus_driver_info *pmbus_get_driver_info(struct i2c_client 4239d2ecfb7SGuenter Roeck *client); 4249d2ecfb7SGuenter Roeck 4259d2ecfb7SGuenter Roeck #endif /* PMBUS_H */ 426