1 /* 2 * Common clock and power management (CPM) abstractions. 3 * 4 * Copyright (C) 2017, 2018, 2020, 2021, 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 #include <l4/devices/cpm-common.h> 25 #include <l4/sys/types.h> 26 #include <stdint.h> 27 28 29 30 #ifdef __cplusplus 31 32 /* A transitional abstraction supporting older CPM abstractions. */ 33 34 class Cpm_chip_base 35 { 36 public: 37 virtual int have_clock(enum Clock_identifiers clock) = 0; 38 virtual void start_clock(enum Clock_identifiers clock) = 0; 39 virtual void stop_clock(enum Clock_identifiers clock) = 0; 40 }; 41 42 /* A simple abstraction for accessing the CPM registers. */ 43 44 class Cpm_chip : public Cpm_chip_base 45 { 46 protected: 47 Clock_base **_clocks; 48 Cpm_regs _cpm_regs; 49 50 public: 51 explicit Cpm_chip(l4_addr_t addr, Clock_base *clocks[]); 52 53 const char *clock_type(enum Clock_identifiers clock); 54 55 // Clock control. 56 57 int have_clock(enum Clock_identifiers clock); 58 void start_clock(enum Clock_identifiers clock); 59 void stop_clock(enum Clock_identifiers clock); 60 61 // Clock dividers. 62 63 int get_parameters(enum Clock_identifiers clock, uint32_t parameters[]); 64 int set_parameters(enum Clock_identifiers clock, int num_parameters, 65 uint32_t parameters[]); 66 67 // Clock sources. 68 69 uint8_t get_source(enum Clock_identifiers clock); 70 void set_source(enum Clock_identifiers clock, uint8_t source); 71 enum Clock_identifiers get_source_clock(enum Clock_identifiers clock); 72 void set_source_clock(enum Clock_identifiers clock, enum Clock_identifiers source); 73 74 // Source frequencies. 75 76 uint32_t get_source_frequency(enum Clock_identifiers clock); 77 78 // Output clock frequencies. 79 80 uint32_t get_frequency(enum Clock_identifiers clock); 81 int set_frequency(enum Clock_identifiers clock, uint32_t frequency); 82 }; 83 84 #endif /* __cplusplus */