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 | #include <l4/devices/hw_mmio_register_block.h> |
paul@173 | 23 | |
paul@173 | 24 | #include "cpm-common.h" |
paul@173 | 25 | #include <math.h> |
paul@173 | 26 | |
paul@173 | 27 | |
paul@173 | 28 | |
paul@173 | 29 | // Register access. |
paul@173 | 30 | |
paul@173 | 31 | Cpm_regs::Cpm_regs(l4_addr_t addr, Clock_base *clocks[], |
paul@173 | 32 | uint32_t exclk_freq) |
paul@173 | 33 | : _clocks(clocks), exclk_freq(exclk_freq) |
paul@173 | 34 | { |
paul@173 | 35 | _regs = new Hw::Mmio_register_block<32>(addr); |
paul@173 | 36 | } |
paul@173 | 37 | |
paul@173 | 38 | // Utility methods. |
paul@173 | 39 | |
paul@173 | 40 | uint32_t |
paul@173 | 41 | Cpm_regs::get_field(uint32_t reg, uint32_t mask, uint8_t shift) |
paul@173 | 42 | { |
paul@173 | 43 | return (_regs[reg] & (mask << shift)) >> shift; |
paul@173 | 44 | } |
paul@173 | 45 | |
paul@173 | 46 | void |
paul@173 | 47 | Cpm_regs::set_field(uint32_t reg, uint32_t mask, uint8_t shift, uint32_t value) |
paul@173 | 48 | { |
paul@173 | 49 | _regs[reg] = (_regs[reg] & (~(mask << shift))) | ((mask & value) << shift); |
paul@173 | 50 | } |
paul@173 | 51 | |
paul@173 | 52 | Clock_base * |
paul@173 | 53 | Cpm_regs::get_clock(int num) |
paul@173 | 54 | { |
paul@173 | 55 | return _clocks[num]; |
paul@173 | 56 | } |
paul@173 | 57 | |
paul@173 | 58 | |
paul@173 | 59 | |
paul@173 | 60 | // Field methods. |
paul@173 | 61 | |
paul@173 | 62 | uint32_t |
paul@173 | 63 | Field::get_field(Cpm_regs ®s) |
paul@173 | 64 | { |
paul@173 | 65 | if (defined) |
paul@173 | 66 | return regs.get_field(reg, mask, bit); |
paul@173 | 67 | else |
paul@173 | 68 | return 0; |
paul@173 | 69 | } |
paul@173 | 70 | |
paul@173 | 71 | void |
paul@173 | 72 | Field::set_field(Cpm_regs ®s, uint32_t value) |
paul@173 | 73 | { |
paul@173 | 74 | if (defined) |
paul@173 | 75 | regs.set_field(reg, mask, bit, value); |
paul@173 | 76 | } |
paul@173 | 77 | |
paul@173 | 78 | // Undefined field. |
paul@173 | 79 | |
paul@173 | 80 | Field Field::undefined; |
paul@173 | 81 | |
paul@173 | 82 | |
paul@173 | 83 | |
paul@173 | 84 | // Clock sources. |
paul@173 | 85 | |
paul@173 | 86 | enum Clock_identifiers |
paul@173 | 87 | Mux::get_input(int num) |
paul@173 | 88 | { |
paul@173 | 89 | if (num < _num_inputs) |
paul@173 | 90 | return _inputs[num]; |
paul@173 | 91 | else |
paul@173 | 92 | return Clock_undefined; |
paul@173 | 93 | } |
paul@173 | 94 | |
paul@173 | 95 | // Clock sources. |
paul@173 | 96 | |
paul@173 | 97 | uint8_t |
paul@173 | 98 | Source::get_source(Cpm_regs ®s) |
paul@173 | 99 | { |
paul@173 | 100 | if (_source.is_defined()) |
paul@173 | 101 | return _source.get_field(regs); |
paul@173 | 102 | else |
paul@173 | 103 | return 0; |
paul@173 | 104 | } |
paul@173 | 105 | |
paul@173 | 106 | void |
paul@173 | 107 | Source::set_source(Cpm_regs ®s, uint8_t source) |
paul@173 | 108 | { |
paul@173 | 109 | if (!_source.is_defined()) |
paul@173 | 110 | return; |
paul@173 | 111 | |
paul@173 | 112 | _source.set_field(regs, source); |
paul@173 | 113 | } |
paul@173 | 114 | |
paul@173 | 115 | // Clock source frequencies. |
paul@173 | 116 | |
paul@173 | 117 | uint32_t |
paul@173 | 118 | Source::get_frequency(Cpm_regs ®s) |
paul@173 | 119 | { |
paul@173 | 120 | // Return the external clock frequency without any input clock. |
paul@173 | 121 | |
paul@173 | 122 | if (get_number() == 0) |
paul@173 | 123 | return regs.exclk_freq; |
paul@173 | 124 | |
paul@173 | 125 | // Clocks with one source yield that input frequency. |
paul@173 | 126 | |
paul@173 | 127 | else if (get_number() == 1) |
paul@173 | 128 | return regs.get_clock(get_input(0))->get_frequency(regs); |
paul@173 | 129 | |
paul@173 | 130 | // With multiple sources, obtain the selected source for the clock. |
paul@173 | 131 | |
paul@173 | 132 | uint8_t source = get_source(regs); |
paul@173 | 133 | enum Clock_identifiers input = get_input(source); |
paul@173 | 134 | |
paul@173 | 135 | // Return the frequency of the source. |
paul@173 | 136 | |
paul@173 | 137 | if (input != Clock_undefined) |
paul@173 | 138 | return regs.get_clock(input)->get_frequency(regs); |
paul@173 | 139 | else |
paul@173 | 140 | return 0; |
paul@173 | 141 | } |
paul@173 | 142 | |
paul@173 | 143 | // Undefined source. |
paul@173 | 144 | |
paul@173 | 145 | Source Source::undefined; |
paul@173 | 146 | |
paul@173 | 147 | |
paul@173 | 148 | |
paul@173 | 149 | // Clock control. |
paul@173 | 150 | |
paul@173 | 151 | int |
paul@173 | 152 | Clock_base::have_clock(Cpm_regs ®s) |
paul@173 | 153 | { |
paul@173 | 154 | (void) regs; |
paul@173 | 155 | return true; |
paul@173 | 156 | } |
paul@173 | 157 | |
paul@173 | 158 | void |
paul@173 | 159 | Clock_base::start_clock(Cpm_regs ®s) |
paul@173 | 160 | { |
paul@173 | 161 | (void) regs; |
paul@173 | 162 | } |
paul@173 | 163 | |
paul@173 | 164 | void |
paul@173 | 165 | Clock_base::stop_clock(Cpm_regs ®s) |
paul@173 | 166 | { |
paul@173 | 167 | (void) regs; |
paul@173 | 168 | } |
paul@173 | 169 | |
paul@173 | 170 | // Default divider. |
paul@173 | 171 | |
paul@173 | 172 | uint32_t |
paul@173 | 173 | Clock_base::get_divider(Cpm_regs ®s) |
paul@173 | 174 | { |
paul@173 | 175 | (void) regs; |
paul@173 | 176 | return 1; |
paul@173 | 177 | } |
paul@173 | 178 | |
paul@173 | 179 | void |
paul@173 | 180 | Clock_base::set_divider(Cpm_regs ®s, uint32_t division) |
paul@173 | 181 | { |
paul@173 | 182 | (void) regs; |
paul@173 | 183 | (void) division; |
paul@173 | 184 | } |
paul@173 | 185 | |
paul@173 | 186 | // Clock sources. |
paul@173 | 187 | |
paul@173 | 188 | uint8_t |
paul@173 | 189 | Clock_base::get_source(Cpm_regs ®s) |
paul@173 | 190 | { |
paul@173 | 191 | return _source.get_source(regs); |
paul@173 | 192 | } |
paul@173 | 193 | |
paul@173 | 194 | void |
paul@173 | 195 | Clock_base::set_source(Cpm_regs ®s, uint8_t source) |
paul@173 | 196 | { |
paul@173 | 197 | _source.set_source(regs, source); |
paul@173 | 198 | } |
paul@173 | 199 | |
paul@173 | 200 | // Clock source frequencies. |
paul@173 | 201 | |
paul@173 | 202 | uint32_t |
paul@173 | 203 | Clock_base::get_source_frequency(Cpm_regs ®s) |
paul@173 | 204 | { |
paul@173 | 205 | return _source.get_frequency(regs); |
paul@173 | 206 | } |
paul@173 | 207 | |
paul@173 | 208 | // Output clock frequencies. |
paul@173 | 209 | |
paul@173 | 210 | uint32_t |
paul@173 | 211 | Clock_base::get_frequency(Cpm_regs ®s) |
paul@173 | 212 | { |
paul@173 | 213 | return get_source_frequency(regs) / get_divider(regs); |
paul@173 | 214 | } |
paul@173 | 215 | |
paul@173 | 216 | |
paul@173 | 217 | |
paul@173 | 218 | // PLL-specific control. |
paul@173 | 219 | |
paul@173 | 220 | int |
paul@173 | 221 | Pll::have_pll(Cpm_regs ®s) |
paul@173 | 222 | { |
paul@173 | 223 | return _stable.get_field(regs); |
paul@173 | 224 | } |
paul@173 | 225 | |
paul@173 | 226 | int |
paul@173 | 227 | Pll::pll_enabled(Cpm_regs ®s) |
paul@173 | 228 | { |
paul@173 | 229 | return _enable.get_field(regs); |
paul@173 | 230 | } |
paul@173 | 231 | |
paul@173 | 232 | int |
paul@173 | 233 | Pll::pll_bypassed(Cpm_regs ®s) |
paul@173 | 234 | { |
paul@173 | 235 | return _bypass.get_field(regs); |
paul@173 | 236 | } |
paul@173 | 237 | |
paul@173 | 238 | // Clock control. |
paul@173 | 239 | |
paul@173 | 240 | int |
paul@173 | 241 | Pll::have_clock(Cpm_regs ®s) |
paul@173 | 242 | { |
paul@173 | 243 | return have_pll(regs) && pll_enabled(regs); |
paul@173 | 244 | } |
paul@173 | 245 | |
paul@173 | 246 | void |
paul@173 | 247 | Pll::start_clock(Cpm_regs ®s) |
paul@173 | 248 | { |
paul@173 | 249 | _enable.set_field(regs, 1); |
paul@173 | 250 | while (!have_pll(regs)); |
paul@173 | 251 | } |
paul@173 | 252 | |
paul@173 | 253 | void |
paul@173 | 254 | Pll::stop_clock(Cpm_regs ®s) |
paul@173 | 255 | { |
paul@173 | 256 | _enable.set_field(regs, 0); |
paul@173 | 257 | while (have_pll(regs)); |
paul@173 | 258 | } |
paul@173 | 259 | |
paul@173 | 260 | // Feedback (13-bit) multiplier. |
paul@173 | 261 | |
paul@173 | 262 | uint16_t |
paul@173 | 263 | Pll::get_multiplier(Cpm_regs ®s) |
paul@173 | 264 | { |
paul@173 | 265 | return _multiplier.get_field(regs) + 1; |
paul@173 | 266 | } |
paul@173 | 267 | |
paul@173 | 268 | void |
paul@173 | 269 | Pll::set_multiplier(Cpm_regs ®s, uint16_t multiplier) |
paul@173 | 270 | { |
paul@173 | 271 | _multiplier.set_field(regs, multiplier - 1); |
paul@173 | 272 | } |
paul@173 | 273 | |
paul@173 | 274 | // Input (6-bit) divider. |
paul@173 | 275 | |
paul@173 | 276 | uint8_t |
paul@173 | 277 | Pll::get_input_division(Cpm_regs ®s) |
paul@173 | 278 | { |
paul@173 | 279 | return _input_division.get_field(regs) + 1; |
paul@173 | 280 | } |
paul@173 | 281 | |
paul@173 | 282 | void |
paul@173 | 283 | Pll::set_input_division(Cpm_regs ®s, uint8_t divider) |
paul@173 | 284 | { |
paul@173 | 285 | _input_division.set_field(regs, divider - 1); |
paul@173 | 286 | } |
paul@173 | 287 | |
paul@173 | 288 | // Output (dual 3-bit) dividers. |
paul@173 | 289 | |
paul@173 | 290 | uint8_t |
paul@173 | 291 | Pll::get_output_division(Cpm_regs ®s) |
paul@173 | 292 | { |
paul@173 | 293 | uint8_t d0 = _output_division0.get_field(regs); |
paul@173 | 294 | uint8_t d1 = _output_division1.get_field(regs); |
paul@173 | 295 | |
paul@173 | 296 | return d0 * d1; |
paul@173 | 297 | } |
paul@173 | 298 | |
paul@173 | 299 | void |
paul@173 | 300 | Pll::set_output_division(Cpm_regs ®s, uint8_t divider) |
paul@173 | 301 | { |
paul@173 | 302 | // Assert 1 as a minimum. |
paul@173 | 303 | // Divider 0 must be less than or equal to divider 1. |
paul@173 | 304 | |
paul@173 | 305 | uint8_t d0 = (uint8_t) floor(sqrt(divider ? divider : 1)); |
paul@173 | 306 | uint8_t d1 = divider / d0; |
paul@173 | 307 | |
paul@173 | 308 | _output_division0.set_field(regs, d0); |
paul@173 | 309 | _output_division1.set_field(regs, d1); |
paul@173 | 310 | } |
paul@173 | 311 | |
paul@173 | 312 | uint32_t |
paul@173 | 313 | Pll::get_frequency(Cpm_regs ®s) |
paul@173 | 314 | { |
paul@173 | 315 | // Test for PLL enable and not PLL bypass. |
paul@173 | 316 | |
paul@173 | 317 | if (pll_enabled(regs)) |
paul@173 | 318 | { |
paul@173 | 319 | if (!pll_bypassed(regs)) |
paul@173 | 320 | return (get_source_frequency(regs) * get_multiplier(regs)) / |
paul@173 | 321 | (get_input_division(regs) * get_output_division(regs)); |
paul@173 | 322 | else |
paul@173 | 323 | return get_source_frequency(regs); |
paul@173 | 324 | } |
paul@173 | 325 | else |
paul@173 | 326 | return 0; |
paul@173 | 327 | } |
paul@173 | 328 | |
paul@173 | 329 | void |
paul@173 | 330 | Pll::set_pll_parameters(Cpm_regs ®s, uint16_t multiplier, uint8_t in_divider, uint8_t out_divider) |
paul@173 | 331 | { |
paul@173 | 332 | set_multiplier(regs, multiplier); |
paul@173 | 333 | set_input_division(regs, in_divider); |
paul@173 | 334 | set_output_division(regs, out_divider); |
paul@173 | 335 | |
paul@173 | 336 | if (pll_enabled(regs) && !pll_bypassed(regs)) |
paul@173 | 337 | while (!have_pll(regs)); |
paul@173 | 338 | } |
paul@173 | 339 | |
paul@173 | 340 | |
paul@173 | 341 | |
paul@173 | 342 | // Clock control. |
paul@173 | 343 | |
paul@173 | 344 | void |
paul@173 | 345 | Clock::change_disable(Cpm_regs ®s) |
paul@173 | 346 | { |
paul@173 | 347 | if (_change_enable.is_defined()) |
paul@173 | 348 | _change_enable.set_field(regs, 0); |
paul@173 | 349 | } |
paul@173 | 350 | |
paul@173 | 351 | void |
paul@173 | 352 | Clock::change_enable(Cpm_regs ®s) |
paul@173 | 353 | { |
paul@173 | 354 | if (_change_enable.is_defined()) |
paul@173 | 355 | _change_enable.set_field(regs, 1); |
paul@173 | 356 | } |
paul@173 | 357 | |
paul@173 | 358 | int |
paul@173 | 359 | Clock::have_clock(Cpm_regs ®s) |
paul@173 | 360 | { |
paul@173 | 361 | if (_gate.is_defined()) |
paul@173 | 362 | return !_gate.get_field(regs); |
paul@173 | 363 | else |
paul@173 | 364 | return true; |
paul@173 | 365 | } |
paul@173 | 366 | |
paul@173 | 367 | void |
paul@173 | 368 | Clock::start_clock(Cpm_regs ®s) |
paul@173 | 369 | { |
paul@173 | 370 | if (_gate.is_defined()) |
paul@173 | 371 | _gate.set_field(regs, 0); |
paul@173 | 372 | } |
paul@173 | 373 | |
paul@173 | 374 | void |
paul@173 | 375 | Clock::stop_clock(Cpm_regs ®s) |
paul@173 | 376 | { |
paul@173 | 377 | if (_gate.is_defined()) |
paul@173 | 378 | _gate.set_field(regs, 1); |
paul@173 | 379 | } |
paul@173 | 380 | |
paul@173 | 381 | void |
paul@173 | 382 | Clock::wait_busy(Cpm_regs ®s) |
paul@173 | 383 | { |
paul@173 | 384 | if (_busy.is_defined()) |
paul@173 | 385 | while (_busy.get_field(regs)); |
paul@173 | 386 | } |
paul@173 | 387 | |
paul@173 | 388 | |
paul@173 | 389 | |
paul@173 | 390 | // Clock dividers. |
paul@173 | 391 | |
paul@173 | 392 | uint32_t |
paul@173 | 393 | Clock::get_divider(Cpm_regs ®s) |
paul@173 | 394 | { |
paul@173 | 395 | if (_divider.is_defined()) |
paul@173 | 396 | return _divider.get_field(regs) + 1; |
paul@173 | 397 | else |
paul@173 | 398 | return 1; |
paul@173 | 399 | } |
paul@173 | 400 | |
paul@173 | 401 | void |
paul@173 | 402 | Clock::set_divider(Cpm_regs ®s, uint32_t division) |
paul@173 | 403 | { |
paul@173 | 404 | if (!_divider.is_defined()) |
paul@173 | 405 | return; |
paul@173 | 406 | |
paul@173 | 407 | change_enable(regs); |
paul@173 | 408 | _divider.set_field(regs, division - 1); |
paul@173 | 409 | wait_busy(regs); |
paul@173 | 410 | change_disable(regs); |
paul@173 | 411 | } |
paul@173 | 412 | |
paul@173 | 413 | void |
paul@173 | 414 | Clock::set_source(Cpm_regs ®s, uint8_t source) |
paul@173 | 415 | { |
paul@173 | 416 | change_enable(regs); |
paul@173 | 417 | Clock_base::set_source(regs, source); |
paul@173 | 418 | wait_busy(regs); |
paul@173 | 419 | change_disable(regs); |
paul@173 | 420 | } |