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