paul@160 | 1 | /* |
paul@160 | 2 | * CPM (clock and power management) support for the X1600. |
paul@160 | 3 | * |
paul@160 | 4 | * Copyright (C) 2017, 2018, 2020, 2021, 2023 Paul Boddie <paul@boddie.org.uk> |
paul@160 | 5 | * |
paul@160 | 6 | * This program is free software; you can redistribute it and/or |
paul@160 | 7 | * modify it under the terms of the GNU General Public License as |
paul@160 | 8 | * published by the Free Software Foundation; either version 2 of |
paul@160 | 9 | * the License, or (at your option) any later version. |
paul@160 | 10 | * |
paul@160 | 11 | * This program is distributed in the hope that it will be useful, |
paul@160 | 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
paul@160 | 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
paul@160 | 14 | * GNU General Public License for more details. |
paul@160 | 15 | * |
paul@160 | 16 | * You should have received a copy of the GNU General Public License |
paul@160 | 17 | * along with this program; if not, write to the Free Software |
paul@160 | 18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, |
paul@160 | 19 | * Boston, MA 02110-1301, USA |
paul@160 | 20 | */ |
paul@160 | 21 | |
paul@160 | 22 | #pragma once |
paul@160 | 23 | |
paul@160 | 24 | #include <l4/devices/cpm.h> |
paul@160 | 25 | |
paul@160 | 26 | #include <l4/sys/types.h> |
paul@160 | 27 | #include <stdint.h> |
paul@160 | 28 | |
paul@160 | 29 | |
paul@160 | 30 | |
paul@160 | 31 | #ifdef __cplusplus |
paul@160 | 32 | |
paul@160 | 33 | #include <l4/devices/hw_register_block.h> |
paul@160 | 34 | |
paul@165 | 35 | /* Register access type. */ |
paul@165 | 36 | |
paul@165 | 37 | class Cpm_regs |
paul@165 | 38 | { |
paul@165 | 39 | Hw::Register_block<32> _regs; |
paul@165 | 40 | |
paul@165 | 41 | public: |
paul@165 | 42 | uint32_t exclk_freq; |
paul@165 | 43 | |
paul@165 | 44 | explicit Cpm_regs(l4_addr_t addr, uint32_t exclk_freq); |
paul@165 | 45 | |
paul@165 | 46 | // Utility methods. |
paul@165 | 47 | |
paul@165 | 48 | uint32_t get_field(uint32_t reg, uint32_t mask, uint8_t shift); |
paul@165 | 49 | void set_field(uint32_t reg, uint32_t mask, uint8_t shift, uint32_t value); |
paul@165 | 50 | }; |
paul@165 | 51 | |
paul@160 | 52 | /* A simple abstraction for accessing the CPM registers. |
paul@160 | 53 | * A proper device could inherit from Hw::Device and use an |
paul@160 | 54 | * Int_property for _exclk_freq. */ |
paul@160 | 55 | |
paul@160 | 56 | class Cpm_x1600_chip : public Cpm_chip |
paul@160 | 57 | { |
paul@160 | 58 | private: |
paul@160 | 59 | Hw::Register_block<32> _regs; |
paul@160 | 60 | uint32_t _exclk_freq; |
paul@165 | 61 | Cpm_regs _cpm_regs; |
paul@160 | 62 | |
paul@160 | 63 | public: |
paul@160 | 64 | Cpm_x1600_chip(l4_addr_t addr, uint32_t exclk_freq); |
paul@160 | 65 | |
paul@160 | 66 | int have_clock(enum Clock_identifiers clock); |
paul@160 | 67 | void start_clock(enum Clock_identifiers clock); |
paul@160 | 68 | void stop_clock(enum Clock_identifiers clock); |
paul@160 | 69 | |
paul@161 | 70 | // Clock dividers. |
paul@160 | 71 | |
paul@161 | 72 | uint32_t get_divider(enum Clock_identifiers clock); |
paul@161 | 73 | void set_divider(enum Clock_identifiers clock, uint32_t divider); |
paul@160 | 74 | |
paul@161 | 75 | // Clock sources. |
paul@160 | 76 | |
paul@161 | 77 | uint8_t get_source(enum Clock_identifiers clock); |
paul@161 | 78 | void set_source(enum Clock_identifiers clock, uint8_t source); |
paul@160 | 79 | |
paul@161 | 80 | // Source frequencies. |
paul@160 | 81 | |
paul@161 | 82 | uint32_t get_source_frequency(enum Clock_identifiers clock); |
paul@160 | 83 | |
paul@161 | 84 | // Output clock frequencies. |
paul@160 | 85 | |
paul@160 | 86 | uint32_t get_frequency(enum Clock_identifiers clock); |
paul@160 | 87 | void set_frequency(enum Clock_identifiers clock, uint32_t frequency); |
paul@161 | 88 | |
paul@161 | 89 | // Other operations. |
paul@161 | 90 | |
paul@165 | 91 | void set_pll_parameters(enum Clock_identifiers clock, uint16_t multiplier, |
paul@165 | 92 | uint8_t in_divider, uint8_t out_divider); |
paul@160 | 93 | }; |
paul@160 | 94 | |
paul@160 | 95 | #endif /* __cplusplus */ |
paul@160 | 96 | |
paul@160 | 97 | |
paul@160 | 98 | |
paul@160 | 99 | /* C language interface. */ |
paul@160 | 100 | |
paul@160 | 101 | EXTERN_C_BEGIN |
paul@160 | 102 | |
paul@160 | 103 | void *x1600_cpm_init(l4_addr_t cpm_base); |
paul@160 | 104 | |
paul@160 | 105 | int x1600_cpm_have_clock(void *cpm, enum Clock_identifiers clock); |
paul@160 | 106 | void x1600_cpm_start_clock(void *cpm, enum Clock_identifiers clock); |
paul@160 | 107 | void x1600_cpm_stop_clock(void *cpm, enum Clock_identifiers clock); |
paul@160 | 108 | |
paul@161 | 109 | uint32_t x1600_cpm_get_divider(void *cpm, enum Clock_identifiers clock); |
paul@161 | 110 | void x1600_cpm_set_divider(void *cpm, enum Clock_identifiers clock, uint32_t divider); |
paul@160 | 111 | |
paul@161 | 112 | uint8_t x1600_cpm_get_source(void *cpm, enum Clock_identifiers clock); |
paul@161 | 113 | void x1600_cpm_set_source(void *cpm, enum Clock_identifiers clock, uint8_t source); |
paul@160 | 114 | |
paul@161 | 115 | uint32_t x1600_cpm_get_source_frequency(void *cpm, enum Clock_identifiers clock); |
paul@160 | 116 | |
paul@160 | 117 | uint32_t x1600_cpm_get_frequency(void *cpm, enum Clock_identifiers clock); |
paul@160 | 118 | void x1600_cpm_set_frequency(void *cpm, enum Clock_identifiers clock, uint32_t frequency); |
paul@160 | 119 | |
paul@160 | 120 | void x1600_cpm_set_mpll_parameters(void *cpm, uint16_t multiplier, uint8_t in_divider, uint8_t out_divider); |
paul@160 | 121 | |
paul@160 | 122 | EXTERN_C_END |