1 /* 2 * Common clock functionality. 3 * 4 * Copyright (C) 2023 Paul Boddie <paul@boddie.org.uk> 5 * 6 * This program is free software; you can redistribute it and/or 7 * modify it under the terms of the GNU General Public License as 8 * published by the Free Software Foundation; either version 2 of 9 * the License, or (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., 51 Franklin Street, Fifth Floor, 19 * Boston, MA 02110-1301, USA 20 */ 21 22 #pragma once 23 24 #ifdef __cplusplus 25 26 #include <l4/devices/clocks.h> 27 #include <l4/devices/hw_register_block.h> 28 #include <l4/sys/types.h> 29 #include <stdint.h> 30 31 /* Forward declaration. */ 32 33 class Clock_base; 34 35 36 37 /* Register access type. */ 38 39 class Cpm_regs 40 { 41 protected: 42 Hw::Register_block<32> _regs; 43 Clock_base **_clocks; 44 45 public: 46 explicit Cpm_regs(l4_addr_t addr, Clock_base *clocks[]); 47 48 // Utility methods. 49 50 uint32_t get_field(uint32_t reg, uint32_t mask, uint8_t shift); 51 void set_field(uint32_t reg, uint32_t mask, uint8_t shift, uint32_t value); 52 53 Clock_base *get_clock(int num); 54 }; 55 56 57 58 // Register field abstraction. 59 60 class Field 61 { 62 uint32_t reg; 63 uint32_t mask; 64 uint8_t bit; 65 bool defined; 66 uint32_t _asserted = 0, _deasserted = 0; 67 68 public: 69 explicit Field() 70 : defined(false) 71 { 72 } 73 74 explicit Field(uint32_t reg, uint32_t mask, uint32_t bit, 75 bool inverted = false) 76 : reg(reg), mask(mask), bit(bit), defined(true) 77 { 78 if (inverted) 79 _deasserted = mask; 80 else 81 _asserted = mask; 82 } 83 84 uint32_t get_field(Cpm_regs ®s); 85 void set_field(Cpm_regs ®s, uint32_t value); 86 87 uint32_t get_asserted() { return _asserted; } 88 uint32_t get_deasserted() { return _deasserted; } 89 90 bool is_defined() { return defined; } 91 uint32_t get_limit() { return mask; } 92 93 // Undefined field object. 94 95 static Field undefined; 96 }; 97 98 99 100 // Clock sources. 101 102 class Mux 103 { 104 int _num_inputs; 105 enum Clock_identifiers *_inputs, _input; 106 107 public: 108 explicit Mux(int num_inputs, enum Clock_identifiers inputs[]) 109 : _num_inputs(num_inputs), _inputs(inputs) 110 { 111 } 112 113 explicit Mux(enum Clock_identifiers input) 114 : _num_inputs(1), _inputs(&_input) 115 { 116 _input = input; 117 } 118 119 explicit Mux() 120 : _num_inputs(0), _inputs(NULL) 121 { 122 } 123 124 int get_number() { return _num_inputs; } 125 enum Clock_identifiers get_input(int num); 126 }; 127 128 129 130 // Controllable clock source. 131 132 class Source 133 { 134 Mux _inputs; 135 Field _source; 136 137 public: 138 explicit Source(Mux inputs, Field source) 139 : _inputs(inputs), _source(source) 140 { 141 } 142 143 explicit Source(Mux inputs) 144 : _inputs(inputs) 145 { 146 } 147 148 explicit Source() 149 { 150 } 151 152 int get_number() { return _inputs.get_number(); } 153 enum Clock_identifiers get_input(int num) { return _inputs.get_input(num); } 154 155 // Clock source. 156 157 uint8_t get_source(Cpm_regs ®s); 158 void set_source(Cpm_regs ®s, uint8_t source); 159 enum Clock_identifiers get_source_clock(Cpm_regs ®s); 160 void set_source_clock(Cpm_regs ®s, enum Clock_identifiers clock); 161 162 // Clock source frequency. 163 164 uint64_t get_frequency(Cpm_regs ®s); 165 }; 166 167 168 169 // Common clock control. 170 171 class Control_base 172 { 173 public: 174 virtual ~Control_base(); 175 176 virtual void change_disable(Cpm_regs ®s); 177 virtual void change_enable(Cpm_regs ®s); 178 179 virtual void wait_busy(Cpm_regs ®s) = 0; 180 virtual int have_clock(Cpm_regs ®s) = 0; 181 virtual void start_clock(Cpm_regs ®s) = 0; 182 virtual void stop_clock(Cpm_regs ®s) = 0; 183 }; 184 185 186 187 // Clock control. 188 189 class Control : public Control_base 190 { 191 Field _gate, _change_enable, _busy; 192 193 public: 194 explicit Control(Field gate, 195 Field change_enable = Field::undefined, 196 Field busy = Field::undefined) 197 : _gate(gate), _change_enable(change_enable), _busy(busy) 198 { 199 } 200 201 explicit Control() 202 : _gate(Field::undefined), _change_enable(Field::undefined), 203 _busy(Field::undefined) 204 { 205 } 206 207 // Clock control. 208 209 void change_disable(Cpm_regs ®s); 210 void change_enable(Cpm_regs ®s); 211 212 void wait_busy(Cpm_regs ®s); 213 int have_clock(Cpm_regs ®s); 214 void start_clock(Cpm_regs ®s); 215 void stop_clock(Cpm_regs ®s); 216 217 // Undefined control object. 218 219 static Control undefined; 220 }; 221 222 223 224 // PLL control. 225 226 class Control_pll : public Control_base 227 { 228 Field _enable, _stable, _bypass; 229 230 // Frequency change sequence state. 231 232 bool _enabled = false; 233 234 // PLL_specific control. 235 236 int have_pll(Cpm_regs ®s); 237 int pll_enabled(Cpm_regs ®s); 238 239 public: 240 explicit Control_pll(Field enable, Field stable, Field bypass) 241 : _enable(enable), _stable(stable), _bypass(bypass) 242 { 243 } 244 245 // Clock control. 246 247 int pll_bypassed(Cpm_regs ®s); 248 249 void pll_bypass(Cpm_regs ®s); 250 void pll_engage(Cpm_regs ®s); 251 252 void change_disable(Cpm_regs ®s); 253 void change_enable(Cpm_regs ®s); 254 255 void wait_busy(Cpm_regs ®s); 256 int have_clock(Cpm_regs ®s); 257 void start_clock(Cpm_regs ®s); 258 void stop_clock(Cpm_regs ®s); 259 }; 260 261 262 263 // Frequency transformation. 264 265 class Divider_base 266 { 267 public: 268 virtual ~Divider_base(); 269 270 // Output frequency. 271 272 virtual uint64_t get_frequency(Cpm_regs ®s, uint64_t source_frequency) = 0; 273 virtual int set_frequency(Cpm_regs ®s, uint64_t source_frequency, uint64_t frequency) = 0; 274 275 // Other operations. 276 277 virtual int get_parameters(Cpm_regs ®s, uint32_t parameters[]) = 0; 278 279 virtual int set_parameters(Cpm_regs ®s, int num_parameters, uint32_t parameters[]) = 0; 280 }; 281 282 283 284 // Simple divider for regular clocks. 285 286 class Divider : public Divider_base 287 { 288 Field _divider; 289 290 public: 291 explicit Divider(Field divider) 292 : _divider(divider) 293 { 294 } 295 296 explicit Divider() 297 : _divider(Field::undefined) 298 { 299 } 300 301 // Clock divider. 302 303 uint32_t get_divider(Cpm_regs ®s); 304 void set_divider(Cpm_regs ®s, uint32_t divider); 305 306 // Output frequency. 307 308 uint64_t get_frequency(Cpm_regs ®s, uint64_t source_frequency); 309 int set_frequency(Cpm_regs ®s, uint64_t source_frequency, uint64_t frequency); 310 311 // Other operations. 312 313 int get_parameters(Cpm_regs ®s, uint32_t parameters[]); 314 int set_parameters(Cpm_regs ®s, int num_parameters, uint32_t parameters[]); 315 }; 316 317 318 319 // Divider for PLLs. 320 321 class Divider_pll : public Divider_base 322 { 323 Field _multiplier, _input_divider, _output_divider0, _output_divider1; 324 double _intermediate_min, _intermediate_max; 325 326 // General frequency modifiers. 327 328 uint32_t get_multiplier(Cpm_regs ®s); 329 void set_multiplier(Cpm_regs ®s, uint32_t multiplier); 330 uint32_t get_input_divider(Cpm_regs ®s); 331 void set_input_divider(Cpm_regs ®s, uint32_t divider); 332 uint32_t get_output_divider(Cpm_regs ®s); 333 void set_output_divider(Cpm_regs ®s, uint32_t divider); 334 335 public: 336 337 // Double output divider constructor. 338 339 explicit Divider_pll(Field multiplier, Field input_divider, 340 Field output_divider0, Field output_divider1, 341 double intermediate_min, double intermediate_max) 342 : _multiplier(multiplier), _input_divider(input_divider), 343 _output_divider0(output_divider0), _output_divider1(output_divider1), 344 _intermediate_min(intermediate_min), _intermediate_max(intermediate_max) 345 { 346 } 347 348 // Single output divider constructor. 349 350 explicit Divider_pll(Field multiplier, Field input_divider, 351 Field output_divider, 352 double intermediate_min, double intermediate_max) 353 : _multiplier(multiplier), _input_divider(input_divider), 354 _output_divider0(output_divider), _output_divider1(Field::undefined), 355 _intermediate_min(intermediate_min), _intermediate_max(intermediate_max) 356 { 357 } 358 359 // Output frequency. 360 361 uint64_t get_frequency(Cpm_regs ®s, uint64_t source_frequency); 362 int set_frequency(Cpm_regs ®s, uint64_t source_frequency, uint64_t frequency); 363 364 // Other operations. 365 366 int get_parameters(Cpm_regs ®s, uint32_t parameters[]); 367 int set_parameters(Cpm_regs ®s, int num_parameters, uint32_t parameters[]); 368 }; 369 370 371 372 // Divider for I2S clocks. 373 374 class Divider_i2s : public Divider_base 375 { 376 Field _multiplier, _divider_N, _divider_D, _auto_N, _auto_D; 377 378 // General frequency modifiers. 379 380 uint32_t get_multiplier(Cpm_regs ®s); 381 uint32_t get_divider_N(Cpm_regs ®s); 382 uint32_t get_divider_D(Cpm_regs ®s); 383 384 public: 385 explicit Divider_i2s(Field multiplier, Field divider_N, Field divider_D, 386 Field auto_N, Field auto_D) 387 : _multiplier(multiplier), _divider_N(divider_N), _divider_D(divider_D), 388 _auto_N(auto_N), _auto_D(auto_D) 389 { 390 } 391 392 // Output frequency. 393 394 uint64_t get_frequency(Cpm_regs ®s, uint64_t source_frequency); 395 int set_frequency(Cpm_regs ®s, uint64_t source_frequency, uint64_t frequency); 396 397 // Other operations. 398 399 int get_parameters(Cpm_regs ®s, uint32_t parameters[]); 400 401 int set_parameters(Cpm_regs ®s, int num_parameters, uint32_t parameters[]); 402 }; 403 404 405 406 // Common clock abstraction. 407 408 class Clock_base 409 { 410 public: 411 virtual ~Clock_base(); 412 413 virtual const char *clock_type() { return "unset"; } 414 415 // Clock control. 416 417 virtual int have_clock(Cpm_regs ®s) = 0; 418 virtual void start_clock(Cpm_regs ®s) = 0; 419 virtual void stop_clock(Cpm_regs ®s) = 0; 420 421 // Output frequency. 422 423 virtual uint64_t get_frequency(Cpm_regs ®s) = 0; 424 }; 425 426 427 428 // Null (absent or undefined) clock abstraction. 429 430 class Clock_null : public Clock_base 431 { 432 public: 433 const char *clock_type() { return "null"; } 434 435 // Clock control. 436 437 int have_clock(Cpm_regs ®s); 438 void start_clock(Cpm_regs ®s); 439 void stop_clock(Cpm_regs ®s); 440 441 // Output frequency. 442 443 uint64_t get_frequency(Cpm_regs ®s); 444 }; 445 446 447 448 // Passive (root or input) clock without any source of its own. 449 450 class Clock_passive : public Clock_base 451 { 452 protected: 453 uint64_t _frequency; 454 455 public: 456 explicit Clock_passive(uint64_t frequency) 457 : _frequency(frequency) 458 { 459 } 460 461 const char *clock_type() { return "passive"; } 462 463 // Clock control. 464 465 virtual int have_clock(Cpm_regs ®s); 466 virtual void start_clock(Cpm_regs ®s); 467 virtual void stop_clock(Cpm_regs ®s); 468 469 // Output frequency. 470 471 uint64_t get_frequency(Cpm_regs ®s); 472 }; 473 474 475 476 class Clock_controlled : public Clock_base 477 { 478 protected: 479 virtual Control_base &_get_control() = 0; 480 481 public: 482 483 // Clock control. 484 485 virtual int have_clock(Cpm_regs ®s); 486 virtual void start_clock(Cpm_regs ®s); 487 virtual void stop_clock(Cpm_regs ®s); 488 }; 489 490 491 492 // An actively managed clock with source. 493 494 class Clock_active : public Clock_controlled 495 { 496 protected: 497 Source _source; 498 499 public: 500 explicit Clock_active(Source source) 501 : _source(source) 502 { 503 } 504 505 virtual ~Clock_active(); 506 507 // Clock source. 508 509 virtual uint8_t get_source(Cpm_regs ®s); 510 virtual void set_source(Cpm_regs ®s, uint8_t source); 511 enum Clock_identifiers get_source_clock(Cpm_regs ®s); 512 void set_source_clock(Cpm_regs ®s, enum Clock_identifiers clock); 513 514 // Clock source frequency. 515 516 virtual uint64_t get_source_frequency(Cpm_regs ®s); 517 518 // Output frequency. 519 520 virtual uint64_t get_frequency(Cpm_regs ®s); 521 }; 522 523 524 525 // Divided clock interface. 526 527 class Clock_divided_base : public Clock_active 528 { 529 protected: 530 virtual Divider_base &_get_divider() = 0; 531 532 public: 533 explicit Clock_divided_base(Source source) 534 : Clock_active(source) 535 { 536 } 537 538 virtual ~Clock_divided_base(); 539 540 virtual int get_parameters(Cpm_regs ®s, uint32_t parameters[]); 541 virtual int set_parameters(Cpm_regs ®s, int num_parameters, uint32_t parameters[]); 542 543 // Output frequency. 544 545 virtual uint64_t get_frequency(Cpm_regs ®s); 546 virtual int set_frequency(Cpm_regs ®s, uint64_t frequency); 547 }; 548 549 550 551 // PLL description. 552 553 class Pll : public Clock_divided_base 554 { 555 Control_pll _control; 556 Divider_pll _divider; 557 558 virtual Control_base &_get_control() { return _control; } 559 virtual Divider_base &_get_divider() { return _divider; } 560 561 public: 562 explicit Pll(Source source, Control_pll control, Divider_pll divider) 563 : Clock_divided_base(source), _control(control), _divider(divider) 564 { 565 } 566 567 virtual ~Pll(); 568 569 const char *clock_type() { return "pll"; } 570 571 // Output frequency. 572 573 uint64_t get_frequency(Cpm_regs ®s); 574 int set_frequency(Cpm_regs ®s, uint64_t frequency); 575 }; 576 577 578 579 // Plain clock description. 580 581 class Clock : public Clock_active 582 { 583 Control _control; 584 585 virtual Control_base &_get_control() { return _control; } 586 587 public: 588 explicit Clock(Source source, Control control) 589 : Clock_active(source), _control(control) 590 { 591 } 592 593 explicit Clock(Source source) 594 : Clock_active(source) 595 { 596 } 597 598 const char *clock_type() { return "clock"; } 599 }; 600 601 602 603 // Divided clock description. 604 605 class Clock_divided : public Clock_divided_base 606 { 607 Control _control; 608 Divider _divider; 609 610 virtual Control_base &_get_control() { return _control; } 611 virtual Divider_base &_get_divider() { return _divider; } 612 613 public: 614 explicit Clock_divided(Source source, Control control, Divider divider) 615 : Clock_divided_base(source), _control(control), _divider(divider) 616 { 617 } 618 619 explicit Clock_divided(Source source, Divider divider) 620 : Clock_divided_base(source), _control(Control::undefined), _divider(divider) 621 { 622 } 623 624 const char *clock_type() { return "divided"; } 625 }; 626 627 628 629 // I2S clock description. 630 631 class Clock_divided_i2s : public Clock_divided_base 632 { 633 Control _control; 634 Divider_i2s _divider; 635 636 virtual Control_base &_get_control() { return _control; } 637 virtual Divider_base &_get_divider() { return _divider; } 638 639 public: 640 explicit Clock_divided_i2s(Source source, Control control, Divider_i2s divider) 641 : Clock_divided_base(source), _control(control), _divider(divider) 642 { 643 } 644 645 const char *clock_type() { return "i2s"; } 646 }; 647 648 #endif /* __cplusplus */