1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Hardware monitoring driver for FSP 3Y-Power PSUs 4 * 5 * Copyright (c) 2021 Václav Kubernát, CESNET 6 * 7 * This driver is mostly reverse engineered with the help of a tool called pmbus_peek written by 8 * David Brownell (and later adopted by Jan Kundrát). The device has some sort of a timing issue 9 * when switching pages, details are explained in the code. The driver support is limited. It 10 * exposes only the values, that have been tested to work correctly. Unsupported values either 11 * aren't supported by the devices or their encondings are unknown. 12 */ 13 14 #include <linux/delay.h> 15 #include <linux/i2c.h> 16 #include <linux/kernel.h> 17 #include <linux/module.h> 18 #include "pmbus.h" 19 20 #define YM2151_PAGE_12V_LOG 0x00 21 #define YM2151_PAGE_12V_REAL 0x00 22 #define YM2151_PAGE_5VSB_LOG 0x01 23 #define YM2151_PAGE_5VSB_REAL 0x20 24 #define YH5151E_PAGE_12V_LOG 0x00 25 #define YH5151E_PAGE_12V_REAL 0x00 26 #define YH5151E_PAGE_5V_LOG 0x01 27 #define YH5151E_PAGE_5V_REAL 0x10 28 #define YH5151E_PAGE_3V3_LOG 0x02 29 #define YH5151E_PAGE_3V3_REAL 0x11 30 31 enum chips { 32 ym2151e, 33 yh5151e 34 }; 35 36 struct fsp3y_data { 37 struct pmbus_driver_info info; 38 int chip; 39 int page; 40 }; 41 42 #define to_fsp3y_data(x) container_of(x, struct fsp3y_data, info) 43 44 static int page_log_to_page_real(int page_log, enum chips chip) 45 { 46 switch (chip) { 47 case ym2151e: 48 switch (page_log) { 49 case YM2151_PAGE_12V_LOG: 50 return YM2151_PAGE_12V_REAL; 51 case YM2151_PAGE_5VSB_LOG: 52 return YM2151_PAGE_5VSB_REAL; 53 } 54 return -EINVAL; 55 case yh5151e: 56 switch (page_log) { 57 case YH5151E_PAGE_12V_LOG: 58 return YH5151E_PAGE_12V_REAL; 59 case YH5151E_PAGE_5V_LOG: 60 return YH5151E_PAGE_5V_REAL; 61 case YH5151E_PAGE_3V3_LOG: 62 return YH5151E_PAGE_3V3_REAL; 63 } 64 return -EINVAL; 65 } 66 67 return -EINVAL; 68 } 69 70 static int set_page(struct i2c_client *client, int page_log) 71 { 72 const struct pmbus_driver_info *info = pmbus_get_driver_info(client); 73 struct fsp3y_data *data = to_fsp3y_data(info); 74 int rv; 75 int page_real; 76 77 if (page_log < 0) 78 return 0; 79 80 page_real = page_log_to_page_real(page_log, data->chip); 81 if (page_real < 0) 82 return page_real; 83 84 if (data->page != page_real) { 85 rv = i2c_smbus_write_byte_data(client, PMBUS_PAGE, page_real); 86 if (rv < 0) 87 return rv; 88 89 data->page = page_real; 90 91 /* 92 * Testing showed that the device has a timing issue. After 93 * setting a page, it takes a while, before the device actually 94 * gives the correct values from the correct page. 20 ms was 95 * tested to be enough to not give wrong values (15 ms wasn't 96 * enough). 97 */ 98 usleep_range(20000, 30000); 99 } 100 101 return 0; 102 } 103 104 static int fsp3y_read_byte_data(struct i2c_client *client, int page, int reg) 105 { 106 const struct pmbus_driver_info *info = pmbus_get_driver_info(client); 107 struct fsp3y_data *data = to_fsp3y_data(info); 108 int rv; 109 110 /* 111 * YH5151-E outputs vout in linear11. The conversion is done when 112 * reading. Here, we have to inject pmbus_core with the correct 113 * exponent (it is -6). 114 */ 115 if (data->chip == yh5151e && reg == PMBUS_VOUT_MODE) 116 return 0x1A; 117 118 rv = set_page(client, page); 119 if (rv < 0) 120 return rv; 121 122 return i2c_smbus_read_byte_data(client, reg); 123 } 124 125 static int fsp3y_read_word_data(struct i2c_client *client, int page, int phase, int reg) 126 { 127 const struct pmbus_driver_info *info = pmbus_get_driver_info(client); 128 struct fsp3y_data *data = to_fsp3y_data(info); 129 int rv; 130 131 /* 132 * This masks commands which weren't tested to work correctly. Some of 133 * the masked commands return 0xFFFF. These would probably get tagged as 134 * invalid by pmbus_core. Other ones do return values which might be 135 * useful (that is, they are not 0xFFFF), but their encoding is unknown, 136 * and so they are unsupported. 137 */ 138 switch (reg) { 139 case PMBUS_READ_FAN_SPEED_1: 140 case PMBUS_READ_IIN: 141 case PMBUS_READ_IOUT: 142 case PMBUS_READ_PIN: 143 case PMBUS_READ_POUT: 144 case PMBUS_READ_TEMPERATURE_1: 145 case PMBUS_READ_TEMPERATURE_2: 146 case PMBUS_READ_TEMPERATURE_3: 147 case PMBUS_READ_VIN: 148 case PMBUS_READ_VOUT: 149 case PMBUS_STATUS_WORD: 150 break; 151 default: 152 return -ENXIO; 153 } 154 155 rv = set_page(client, page); 156 if (rv < 0) 157 return rv; 158 159 rv = i2c_smbus_read_word_data(client, reg); 160 if (rv < 0) 161 return rv; 162 163 /* 164 * YH-5151E is non-compliant and outputs output voltages in linear11 165 * instead of linear16. 166 */ 167 if (data->chip == yh5151e && reg == PMBUS_READ_VOUT) 168 rv = sign_extend32(rv, 10) & 0xffff; 169 170 return rv; 171 } 172 173 static struct pmbus_driver_info fsp3y_info[] = { 174 [ym2151e] = { 175 .pages = 2, 176 .func[YM2151_PAGE_12V_LOG] = 177 PMBUS_HAVE_VOUT | PMBUS_HAVE_IOUT | 178 PMBUS_HAVE_PIN | PMBUS_HAVE_POUT | 179 PMBUS_HAVE_TEMP | PMBUS_HAVE_TEMP2 | 180 PMBUS_HAVE_VIN | PMBUS_HAVE_IIN | 181 PMBUS_HAVE_FAN12, 182 .func[YM2151_PAGE_5VSB_LOG] = 183 PMBUS_HAVE_VOUT | PMBUS_HAVE_IOUT, 184 PMBUS_HAVE_IIN, 185 .read_word_data = fsp3y_read_word_data, 186 .read_byte_data = fsp3y_read_byte_data, 187 }, 188 [yh5151e] = { 189 .pages = 3, 190 .func[YH5151E_PAGE_12V_LOG] = 191 PMBUS_HAVE_VOUT | PMBUS_HAVE_IOUT | 192 PMBUS_HAVE_POUT | 193 PMBUS_HAVE_TEMP | PMBUS_HAVE_TEMP2 | PMBUS_HAVE_TEMP3, 194 .func[YH5151E_PAGE_5V_LOG] = 195 PMBUS_HAVE_VOUT | PMBUS_HAVE_IOUT | 196 PMBUS_HAVE_POUT, 197 .func[YH5151E_PAGE_3V3_LOG] = 198 PMBUS_HAVE_VOUT | PMBUS_HAVE_IOUT | 199 PMBUS_HAVE_POUT, 200 .read_word_data = fsp3y_read_word_data, 201 .read_byte_data = fsp3y_read_byte_data, 202 } 203 }; 204 205 static int fsp3y_detect(struct i2c_client *client) 206 { 207 int rv; 208 u8 buf[I2C_SMBUS_BLOCK_MAX + 1]; 209 210 rv = i2c_smbus_read_block_data(client, PMBUS_MFR_MODEL, buf); 211 if (rv < 0) 212 return rv; 213 214 buf[rv] = '\0'; 215 216 if (rv == 8) { 217 if (!strcmp(buf, "YM-2151E")) 218 return ym2151e; 219 else if (!strcmp(buf, "YH-5151E")) 220 return yh5151e; 221 } 222 223 dev_err(&client->dev, "Unsupported model %.*s\n", rv, buf); 224 return -ENODEV; 225 } 226 227 static const struct i2c_device_id fsp3y_id[] = { 228 {"ym2151e", ym2151e}, 229 {"yh5151e", yh5151e}, 230 { } 231 }; 232 233 static int fsp3y_probe(struct i2c_client *client) 234 { 235 struct fsp3y_data *data; 236 const struct i2c_device_id *id; 237 int rv; 238 239 data = devm_kzalloc(&client->dev, sizeof(struct fsp3y_data), GFP_KERNEL); 240 if (!data) 241 return -ENOMEM; 242 243 data->chip = fsp3y_detect(client); 244 if (data->chip < 0) 245 return data->chip; 246 247 id = i2c_match_id(fsp3y_id, client); 248 if (data->chip != id->driver_data) 249 dev_warn(&client->dev, "Device mismatch: Configured %s (%d), detected %d\n", 250 id->name, (int)id->driver_data, data->chip); 251 252 rv = i2c_smbus_read_byte_data(client, PMBUS_PAGE); 253 if (rv < 0) 254 return rv; 255 data->page = rv; 256 257 data->info = fsp3y_info[data->chip]; 258 259 return pmbus_do_probe(client, &data->info); 260 } 261 262 MODULE_DEVICE_TABLE(i2c, fsp3y_id); 263 264 static struct i2c_driver fsp3y_driver = { 265 .driver = { 266 .name = "fsp3y", 267 }, 268 .probe_new = fsp3y_probe, 269 .id_table = fsp3y_id 270 }; 271 272 module_i2c_driver(fsp3y_driver); 273 274 MODULE_AUTHOR("Václav Kubernát"); 275 MODULE_DESCRIPTION("PMBus driver for FSP/3Y-Power power supplies"); 276 MODULE_LICENSE("GPL"); 277 MODULE_IMPORT_NS(PMBUS); 278