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