1 // SPDX-License-Identifier: BSD-2-Clause 2 /* 3 * Copyright (c) 2023, STMicroelectronics 4 */ 5 6 #include <assert.h> 7 #include <compiler.h> 8 #include <config.h> 9 #include <drivers/regulator.h> 10 #include <initcall.h> 11 #include <keep.h> 12 #include <kernel/boot.h> 13 #include <kernel/delay.h> 14 #include <kernel/mutex_pm_aware.h> 15 #include <kernel/panic.h> 16 #include <kernel/pm.h> 17 #include <kernel/tee_time.h> 18 #include <kernel/thread.h> 19 #include <libfdt.h> 20 #include <limits.h> 21 #include <stdint.h> 22 #include <stdio.h> 23 #include <string.h> 24 #include <util.h> 25 26 static SLIST_HEAD(, regulator) regulator_device_list = 27 SLIST_HEAD_INITIALIZER(regulator); 28 29 /* Access protection mutex complying the power state transitions context */ 30 static void lock_regulator(struct regulator *regulator) 31 { 32 mutex_pm_aware_lock(®ulator->mutex); 33 } 34 35 static void unlock_regulator(struct regulator *regulator) 36 { 37 mutex_pm_aware_unlock(®ulator->mutex); 38 } 39 40 static TEE_Result set_state(struct regulator *regulator, bool on_not_off) 41 { 42 if (!regulator->ops->set_state) 43 return TEE_SUCCESS; 44 45 return regulator->ops->set_state(regulator, on_not_off); 46 } 47 48 static TEE_Result regulator_refcnt_enable(struct regulator *regulator) 49 { 50 TEE_Result res = TEE_ERROR_GENERIC; 51 52 FMSG("%s", regulator_name(regulator)); 53 54 if (regulator->supply) { 55 res = regulator_enable(regulator->supply); 56 if (res) 57 return res; 58 } 59 60 lock_regulator(regulator); 61 62 if (!regulator->refcount) { 63 res = set_state(regulator, true); 64 if (res) { 65 EMSG("regul %s set state failed with %#"PRIx32, 66 regulator_name(regulator), res); 67 68 unlock_regulator(regulator); 69 70 if (regulator->supply && 71 regulator_disable(regulator->supply)) 72 panic(); 73 74 return res; 75 } 76 } 77 78 regulator->refcount++; 79 if (!regulator->refcount) 80 panic(); 81 82 FMSG("%s refcount: %u", regulator_name(regulator), regulator->refcount); 83 84 unlock_regulator(regulator); 85 86 return TEE_SUCCESS; 87 } 88 89 TEE_Result regulator_enable(struct regulator *regulator) 90 { 91 assert(regulator); 92 FMSG("%s", regulator_name(regulator)); 93 94 if (regulator_is_always_on(regulator)) 95 return TEE_SUCCESS; 96 97 return regulator_refcnt_enable(regulator); 98 } 99 100 static TEE_Result regulator_refcnt_disable(struct regulator *regulator) 101 { 102 FMSG("%s", regulator_name(regulator)); 103 104 lock_regulator(regulator); 105 106 if (regulator->refcount == 1) { 107 TEE_Result res = set_state(regulator, false); 108 109 if (res) { 110 EMSG("regul %s set state failed with %#"PRIx32, 111 regulator_name(regulator), res); 112 unlock_regulator(regulator); 113 return res; 114 } 115 } 116 117 if (!regulator->refcount) { 118 EMSG("Unbalanced %s", regulator_name(regulator)); 119 panic(); 120 } 121 122 regulator->refcount--; 123 124 FMSG("%s refcount: %u", regulator_name(regulator), regulator->refcount); 125 126 unlock_regulator(regulator); 127 128 if (regulator->supply && regulator_disable(regulator->supply)) { 129 /* We can't leave this unbalanced */ 130 EMSG("Can't disable %s", regulator_name(regulator->supply)); 131 panic(); 132 } 133 134 return TEE_SUCCESS; 135 } 136 137 TEE_Result regulator_disable(struct regulator *regulator) 138 { 139 assert(regulator); 140 FMSG("%s", regulator_name(regulator)); 141 142 if (regulator_is_always_on(regulator)) 143 return TEE_SUCCESS; 144 145 return regulator_refcnt_disable(regulator); 146 } 147 148 bool regulator_is_enabled(struct regulator *regulator) 149 { 150 TEE_Result res = TEE_SUCCESS; 151 bool enabled = false; 152 153 if (!regulator->ops->get_state) 154 return true; 155 156 lock_regulator(regulator); 157 res = regulator->ops->get_state(regulator, &enabled); 158 unlock_regulator(regulator); 159 160 if (res) 161 EMSG("regul %s get state failed with %#"PRIx32, 162 regulator_name(regulator), res); 163 164 return !res && enabled; 165 } 166 167 int regulator_get_voltage(struct regulator *regulator) 168 { 169 TEE_Result res = TEE_SUCCESS; 170 int level_uv = regulator->min_uv; 171 172 if (regulator->ops->get_voltage) { 173 res = regulator->ops->get_voltage(regulator, &level_uv); 174 if (res) { 175 EMSG("%s get_voltage failed with %#"PRIx32, 176 regulator_name(regulator), res); 177 level_uv = 0; 178 } 179 } 180 181 return level_uv; 182 } 183 184 TEE_Result regulator_set_voltage(struct regulator *regulator, int level_uv) 185 { 186 TEE_Result res = TEE_ERROR_GENERIC; 187 int cur_uv = 0; 188 189 assert(regulator); 190 FMSG("%s %duV", regulator_name(regulator), level_uv); 191 192 if (level_uv < regulator->min_uv || level_uv > regulator->max_uv) 193 return TEE_ERROR_BAD_PARAMETERS; 194 195 cur_uv = regulator_get_voltage(regulator); 196 if (level_uv == cur_uv) 197 return TEE_SUCCESS; 198 199 if (!regulator->ops->set_voltage) 200 return TEE_ERROR_NOT_SUPPORTED; 201 202 lock_regulator(regulator); 203 res = regulator->ops->set_voltage(regulator, level_uv); 204 unlock_regulator(regulator); 205 206 if (res) { 207 EMSG("regul %s set volt failed with %#"PRIx32, 208 regulator_name(regulator), res); 209 return res; 210 } 211 212 return TEE_SUCCESS; 213 } 214 215 TEE_Result regulator_supported_voltages(struct regulator *regulator, 216 struct regulator_voltages_desc **desc, 217 const int **levels) 218 { 219 assert(regulator && desc && levels); 220 221 if (regulator->ops->supported_voltages) { 222 TEE_Result res = TEE_ERROR_GENERIC; 223 224 res = regulator->ops->supported_voltages(regulator, desc, 225 levels); 226 if (res != TEE_ERROR_NOT_SUPPORTED) 227 return res; 228 } else { 229 *desc = ®ulator->voltages_fallback.desc; 230 *levels = regulator->voltages_fallback.levels; 231 } 232 233 assert(((*desc)->type == VOLTAGE_TYPE_FULL_LIST && 234 (*levels)[0] >= regulator->min_uv && (*desc)->num_levels && 235 (*levels)[(*desc)->num_levels - 1] <= regulator->max_uv) || 236 ((*desc)->type == VOLTAGE_TYPE_INCREMENT && 237 (*levels)[0] >= regulator->min_uv && 238 (*levels)[1] <= regulator->max_uv)); 239 240 return TEE_SUCCESS; 241 } 242 243 TEE_Result regulator_register(struct regulator *regulator) 244 { 245 TEE_Result res = TEE_SUCCESS; 246 int min_uv = 0; 247 int max_uv = 0; 248 int uv = 0; 249 250 if (!regulator || !regulator->ops || 251 regulator->flags & ~REGULATOR_FLAGS_MASK) 252 return TEE_ERROR_BAD_PARAMETERS; 253 254 mutex_pm_aware_init(®ulator->mutex); 255 256 regulator_get_range(regulator, &min_uv, &max_uv); 257 if (min_uv > max_uv) 258 return TEE_ERROR_BAD_PARAMETERS; 259 260 /* Sanitize regulator effective level */ 261 uv = regulator_get_voltage(regulator); 262 263 if (uv < min_uv || uv > max_uv) { 264 res = regulator_set_voltage(regulator, min_uv); 265 if (res) 266 return res; 267 } 268 269 /* Unbalanced enable refcount to keep always-on regulators enabled */ 270 if (regulator_is_always_on(regulator)) { 271 res = regulator_refcnt_enable(regulator); 272 if (res) 273 return res; 274 } 275 276 /* Preset voltage list in case ops::supported_voltages is NULL */ 277 if (regulator->min_uv == regulator->max_uv) { 278 regulator->voltages_fallback.desc.type = VOLTAGE_TYPE_FULL_LIST; 279 regulator->voltages_fallback.desc.num_levels = 1; 280 regulator->voltages_fallback.levels[0] = regulator->min_uv; 281 } else { 282 regulator->voltages_fallback.desc.type = VOLTAGE_TYPE_INCREMENT; 283 regulator->voltages_fallback.levels[0] = regulator->min_uv; 284 regulator->voltages_fallback.levels[1] = regulator->max_uv; 285 regulator->voltages_fallback.levels[2] = 1; 286 } 287 288 SLIST_INSERT_HEAD(®ulator_device_list, regulator, link); 289 290 return TEE_SUCCESS; 291 } 292 293 /* 294 * Clean-up regulators that are not used. 295 */ 296 static TEE_Result regulator_core_cleanup(void) 297 { 298 struct regulator *regulator = NULL; 299 300 SLIST_FOREACH(regulator, ®ulator_device_list, link) { 301 if (!regulator->refcount) { 302 DMSG("disable %s", regulator_name(regulator)); 303 lock_regulator(regulator); 304 set_state(regulator, false /* disable */); 305 unlock_regulator(regulator); 306 } 307 } 308 309 regulator_print_tree(); 310 311 return TEE_SUCCESS; 312 } 313 314 release_init_resource(regulator_core_cleanup); 315 316 /* Return updated message buffer position of NULL on failure */ 317 static __printf(3, 4) char *add_msg(char *cur, char *end, const char *fmt, ...) 318 { 319 va_list ap = { }; 320 int max_len = end - cur; 321 int ret = 0; 322 323 va_start(ap, fmt); 324 ret = vsnprintf(cur, max_len, fmt, ap); 325 va_end(ap); 326 327 if (ret < 0 || ret >= max_len) 328 return NULL; 329 330 return cur + ret; 331 } 332 333 static struct regulator *find_next_regulator(struct regulator *parent, 334 struct regulator *sibling) 335 { 336 struct regulator *regulator = NULL; 337 338 if (sibling) 339 regulator = SLIST_NEXT(sibling, link); 340 else 341 regulator = SLIST_FIRST(®ulator_device_list); 342 343 while (regulator && regulator->supply != parent) 344 regulator = SLIST_NEXT(regulator, link); 345 346 return regulator; 347 } 348 349 /* Regulator is the last supplied one by its supply in the registered list */ 350 static bool regulator_is_supply_last_supplied(struct regulator *regulator) 351 { 352 return !find_next_regulator(regulator->supply, regulator); 353 } 354 355 /* Supply last node may already be printed for indentation level @cur_indent */ 356 static bool indent_with_empty_string(struct regulator *node_regulator, 357 int node_indent, int cur_indent) 358 { 359 struct regulator *r = node_regulator; 360 int n = 0; 361 362 /* Find supply at indentation level @node_indent - @cur_indent - 1 */ 363 for (n = 0; n < node_indent - cur_indent - 1; n++) 364 r = r->supply; 365 366 return regulator_is_supply_last_supplied(r); 367 } 368 369 static void __maybe_unused print_regulator(struct regulator *regulator, 370 int indent) 371 { 372 static const char * const level_unit[] = { "uV", "mV", "V" }; 373 int max_unit = ARRAY_SIZE(level_unit); 374 int level_max = 0; 375 int level_min = 0; 376 int level_cur = 0; 377 char msg_buf[128] = { }; 378 char *msg_end = msg_buf + sizeof(msg_buf); 379 char *msg = msg_buf; 380 int n_max = 0; 381 int n_min = 0; 382 int n_cur = 0; 383 int n = 0; 384 385 if (indent) { 386 /* Indent for root clock level */ 387 msg = add_msg(msg, msg_end, " "); 388 if (!msg) 389 goto out; 390 391 /* Indent for root supply to regulator supply levels */ 392 for (n = 0; n < indent - 1; n++) { 393 if (indent_with_empty_string(regulator, indent, n)) 394 msg = add_msg(msg, msg_end, " "); 395 else 396 msg = add_msg(msg, msg_end, "| "); 397 if (!msg) 398 goto out; 399 } 400 401 /* Regulator indentation */ 402 if (regulator_is_supply_last_supplied(regulator)) 403 msg = add_msg(msg, msg_end, "`-- "); 404 else 405 msg = add_msg(msg, msg_end, "|-- "); 406 407 if (!msg) 408 goto out; 409 } else { 410 /* Root supply indentation */ 411 msg = add_msg(msg, msg_end, "o- "); 412 } 413 414 regulator_get_range(regulator, &level_min, &level_max); 415 level_cur = regulator_get_voltage(regulator); 416 417 for (n_cur = 1; !(level_cur % 1000) && n_cur < max_unit; n_cur++) 418 level_cur /= 1000; 419 for (n_max = 1; !(level_max % 1000) && n_max < max_unit; n_max++) 420 level_max /= 1000; 421 for (n_min = 1; !(level_min % 1000) && n_min < max_unit; n_min++) 422 level_min /= 1000; 423 424 msg = add_msg(msg, msg_end, "%s \t(%3s / refcnt %u / flags %#"PRIx32 425 " / %d %s ", regulator_name(regulator), 426 regulator_is_enabled(regulator) ? "on " : "off", 427 regulator->refcount, regulator->flags, 428 level_cur, level_unit[n_cur - 1]); 429 if (!msg) 430 goto out; 431 432 if (level_min == level_max) 433 msg = add_msg(msg, msg_end, "fixed)"); 434 else if (level_max == INT_MAX) 435 msg = add_msg(msg, msg_end, "[%d %s .. MAX])", 436 level_min, level_unit[n_min - 1]); 437 else 438 msg = add_msg(msg, msg_end, "[%d %s .. %d %s])", 439 level_min, level_unit[n_min - 1], 440 level_max, level_unit[n_max - 1]); 441 442 out: 443 if (!msg) 444 snprintf(msg_end - 4, 4, "..."); 445 446 DMSG("%s", msg_buf); 447 } 448 449 static void print_tree(void) 450 { 451 struct regulator *regulator = NULL; 452 struct regulator *parent = NULL; 453 struct regulator *next = NULL; 454 int indent = -1; 455 456 while (true) { 457 next = find_next_regulator(parent, regulator); 458 if (next) { 459 print_regulator(next, indent + 1); 460 /* Enter the subtree of the next regulator */ 461 parent = next; 462 indent++; 463 regulator = NULL; 464 } else { 465 /* 466 * We've processed all children at this level. 467 * If parent is NULL we're at the top and are done. 468 */ 469 if (!parent) 470 break; 471 /* 472 * Move up one level to resume with the next 473 * regulator of the parent. 474 */ 475 regulator = parent; 476 parent = regulator->supply; 477 indent--; 478 } 479 } 480 } 481 482 void regulator_print_tree(void) 483 { 484 if (IS_ENABLED(CFG_DRIVERS_REGULATOR_PRINT_TREE) && 485 TRACE_LEVEL >= TRACE_DEBUG) { 486 DMSG("Regulator tree summary"); 487 if (SLIST_EMPTY(®ulator_device_list)) 488 DMSG("-- No registered regulator"); 489 else 490 print_tree(); 491 } 492 } 493