10d09e41aSPaolo Bonzini /* 20d09e41aSPaolo Bonzini * General purpose implementation of a simple periodic countdown timer. 30d09e41aSPaolo Bonzini * 40d09e41aSPaolo Bonzini * Copyright (c) 2007 CodeSourcery. 50d09e41aSPaolo Bonzini * 60d09e41aSPaolo Bonzini * This code is licensed under the GNU LGPL. 70d09e41aSPaolo Bonzini */ 80d09e41aSPaolo Bonzini #ifndef PTIMER_H 90d09e41aSPaolo Bonzini #define PTIMER_H 100d09e41aSPaolo Bonzini 110d09e41aSPaolo Bonzini #include "qemu/timer.h" 120d09e41aSPaolo Bonzini 13af2a580fSPeter Maydell /* 14af2a580fSPeter Maydell * The ptimer API implements a simple periodic countdown timer. 15a7a305aeSPeter Maydell * The countdown timer has a value (which can be read and written via 16a7a305aeSPeter Maydell * ptimer_get_count() and ptimer_set_count()). When it is enabled 17a7a305aeSPeter Maydell * using ptimer_run(), the value will count downwards at the frequency 18a7a305aeSPeter Maydell * which has been configured using ptimer_set_period() or ptimer_set_freq(). 19af2a580fSPeter Maydell * When it reaches zero it will trigger a callback function, and 20a7a305aeSPeter Maydell * can be set to either reload itself from a specified limit value 21a7a305aeSPeter Maydell * and keep counting down, or to stop (as a one-shot timer). 22a7a305aeSPeter Maydell * 23af2a580fSPeter Maydell * A transaction-based API is used for modifying ptimer state: all calls 24af2a580fSPeter Maydell * to functions which modify ptimer state must be between matched calls to 25af2a580fSPeter Maydell * ptimer_transaction_begin() and ptimer_transaction_commit(). 26af2a580fSPeter Maydell * When ptimer_transaction_commit() is called it will evaluate the state 27af2a580fSPeter Maydell * of the timer after all the changes in the transaction, and call the 28af2a580fSPeter Maydell * callback if necessary. (See the ptimer_init() documentation for the full 29af2a580fSPeter Maydell * list of state-modifying functions and detailed semantics of the callback.) 30af2a580fSPeter Maydell * 31a7a305aeSPeter Maydell * Forgetting to set the period/frequency (or setting it to zero) is a 32a7a305aeSPeter Maydell * bug in the QEMU device and will cause warning messages to be printed 33a7a305aeSPeter Maydell * to stderr when the guest attempts to enable the timer. 34a7a305aeSPeter Maydell */ 35a7a305aeSPeter Maydell 36*9598c1bbSPeter Maydell /* 37*9598c1bbSPeter Maydell * The 'legacy' ptimer policy retains backward compatibility with the 38*9598c1bbSPeter Maydell * traditional ptimer behaviour from before policy flags were introduced. 39*9598c1bbSPeter Maydell * It has several weird behaviours which don't match typical hardware 40*9598c1bbSPeter Maydell * timer behaviour. For a new device using ptimers, you should not 41*9598c1bbSPeter Maydell * use PTIMER_POLICY_LEGACY, but instead check the actual behaviour 42*9598c1bbSPeter Maydell * that you need and specify the right set of policy flags to get that. 43*9598c1bbSPeter Maydell * 44*9598c1bbSPeter Maydell * If you are overhauling an existing device that uses PTIMER_POLICY_LEGACY 45*9598c1bbSPeter Maydell * and are in a position to check or test the real hardware behaviour, 46*9598c1bbSPeter Maydell * consider updating it to specify the right policy flags. 47e7ea81c3SDmitry Osipenko * 48e7ea81c3SDmitry Osipenko * The rough edges of the default policy: 49e7ea81c3SDmitry Osipenko * - Starting to run with a period = 0 emits error message and stops the 50e7ea81c3SDmitry Osipenko * timer without a trigger. 51e7ea81c3SDmitry Osipenko * 52e7ea81c3SDmitry Osipenko * - Setting period to 0 of the running timer emits error message and 53e7ea81c3SDmitry Osipenko * stops the timer without a trigger. 54e7ea81c3SDmitry Osipenko * 55e7ea81c3SDmitry Osipenko * - Starting to run with counter = 0 or setting it to "0" while timer 56e7ea81c3SDmitry Osipenko * is running causes a trigger and reloads counter with a limit value. 57e7ea81c3SDmitry Osipenko * If limit = 0, ptimer emits error message and stops the timer. 58e7ea81c3SDmitry Osipenko * 59e7ea81c3SDmitry Osipenko * - Counter value of the running timer is one less than the actual value. 60e7ea81c3SDmitry Osipenko * 61e7ea81c3SDmitry Osipenko * - Changing period/frequency of the running timer loses time elapsed 62e7ea81c3SDmitry Osipenko * since the last period, effectively restarting the timer with a 63e7ea81c3SDmitry Osipenko * counter = counter value at the moment of change (.i.e. one less). 64e7ea81c3SDmitry Osipenko */ 65*9598c1bbSPeter Maydell #define PTIMER_POLICY_LEGACY 0 66e7ea81c3SDmitry Osipenko 672b5c0322SDmitry Osipenko /* Periodic timer counter stays with "0" for a one period before wrapping 682b5c0322SDmitry Osipenko * around. */ 692b5c0322SDmitry Osipenko #define PTIMER_POLICY_WRAP_AFTER_ONE_PERIOD (1 << 0) 702b5c0322SDmitry Osipenko 71ef0a9984SDmitry Osipenko /* Running periodic timer that has counter = limit = 0 would continuously 72ef0a9984SDmitry Osipenko * re-trigger every period. */ 73ef0a9984SDmitry Osipenko #define PTIMER_POLICY_CONTINUOUS_TRIGGER (1 << 1) 74ef0a9984SDmitry Osipenko 7522471b8aSDmitry Osipenko /* Starting to run with/setting counter to "0" won't trigger immediately, 7622471b8aSDmitry Osipenko * but after a one period for both oneshot and periodic modes. */ 7722471b8aSDmitry Osipenko #define PTIMER_POLICY_NO_IMMEDIATE_TRIGGER (1 << 2) 7822471b8aSDmitry Osipenko 793f6e6a13SDmitry Osipenko /* Starting to run with/setting counter to "0" won't re-load counter 803f6e6a13SDmitry Osipenko * immediately, but after a one period. */ 813f6e6a13SDmitry Osipenko #define PTIMER_POLICY_NO_IMMEDIATE_RELOAD (1 << 3) 823f6e6a13SDmitry Osipenko 835580ea45SDmitry Osipenko /* Make counter value of the running timer represent the actual value and 845580ea45SDmitry Osipenko * not the one less. */ 855580ea45SDmitry Osipenko #define PTIMER_POLICY_NO_COUNTER_ROUND_DOWN (1 << 4) 865580ea45SDmitry Osipenko 87086ede32SPeter Maydell /* 88086ede32SPeter Maydell * Starting to run with a zero counter, or setting the counter to "0" via 89086ede32SPeter Maydell * ptimer_set_count() or ptimer_set_limit() will not trigger the timer 90086ede32SPeter Maydell * (though it will cause a reload). Only a counter decrement to "0" 91086ede32SPeter Maydell * will cause a trigger. Not compatible with NO_IMMEDIATE_TRIGGER; 92af2a580fSPeter Maydell * ptimer_init() will assert() that you don't set both. 93086ede32SPeter Maydell */ 94086ede32SPeter Maydell #define PTIMER_POLICY_TRIGGER_ONLY_ON_DECREMENT (1 << 5) 95086ede32SPeter Maydell 960d09e41aSPaolo Bonzini /* ptimer.c */ 970d09e41aSPaolo Bonzini typedef struct ptimer_state ptimer_state; 980d09e41aSPaolo Bonzini typedef void (*ptimer_cb)(void *opaque); 990d09e41aSPaolo Bonzini 100a7a305aeSPeter Maydell /** 10178b6eaa6SPeter Maydell * ptimer_init - Allocate and return a new ptimer 10278b6eaa6SPeter Maydell * @callback: function to call on ptimer expiry 10378b6eaa6SPeter Maydell * @callback_opaque: opaque pointer passed to @callback 10478b6eaa6SPeter Maydell * @policy: PTIMER_POLICY_* bits specifying behaviour 10578b6eaa6SPeter Maydell * 10678b6eaa6SPeter Maydell * The ptimer returned must be freed using ptimer_free(). 10778b6eaa6SPeter Maydell * 10878b6eaa6SPeter Maydell * If a ptimer is created using this API then will use the 10978b6eaa6SPeter Maydell * transaction-based API for modifying ptimer state: all calls 11078b6eaa6SPeter Maydell * to functions which modify ptimer state: 11178b6eaa6SPeter Maydell * - ptimer_set_period() 11278b6eaa6SPeter Maydell * - ptimer_set_freq() 11378b6eaa6SPeter Maydell * - ptimer_set_limit() 11478b6eaa6SPeter Maydell * - ptimer_set_count() 11578b6eaa6SPeter Maydell * - ptimer_run() 11678b6eaa6SPeter Maydell * - ptimer_stop() 11778b6eaa6SPeter Maydell * must be between matched calls to ptimer_transaction_begin() 11878b6eaa6SPeter Maydell * and ptimer_transaction_commit(). When ptimer_transaction_commit() 11978b6eaa6SPeter Maydell * is called it will evaluate the state of the timer after all the 12078b6eaa6SPeter Maydell * changes in the transaction, and call the callback if necessary. 12178b6eaa6SPeter Maydell * 12278b6eaa6SPeter Maydell * The callback function is always called from within a transaction 12378b6eaa6SPeter Maydell * begin/commit block, so the callback should not call the 12478b6eaa6SPeter Maydell * ptimer_transaction_begin() function itself. If the callback changes 12578b6eaa6SPeter Maydell * the ptimer state such that another ptimer expiry is triggered, then 12678b6eaa6SPeter Maydell * the callback will be called a second time after the first call returns. 12778b6eaa6SPeter Maydell */ 12878b6eaa6SPeter Maydell ptimer_state *ptimer_init(ptimer_cb callback, 12978b6eaa6SPeter Maydell void *callback_opaque, 13078b6eaa6SPeter Maydell uint8_t policy_mask); 13178b6eaa6SPeter Maydell 13278b6eaa6SPeter Maydell /** 133a7a305aeSPeter Maydell * ptimer_free - Free a ptimer 134a7a305aeSPeter Maydell * @s: timer to free 135a7a305aeSPeter Maydell * 136af2a580fSPeter Maydell * Free a ptimer created using ptimer_init(). 137a7a305aeSPeter Maydell */ 138072bdb07SMarc-André Lureau void ptimer_free(ptimer_state *s); 139a7a305aeSPeter Maydell 140a7a305aeSPeter Maydell /** 14178b6eaa6SPeter Maydell * ptimer_transaction_begin() - Start a ptimer modification transaction 14278b6eaa6SPeter Maydell * 14378b6eaa6SPeter Maydell * This function must be called before making any calls to functions 14478b6eaa6SPeter Maydell * which modify the ptimer's state (see the ptimer_init() documentation 14578b6eaa6SPeter Maydell * for a list of these), and must always have a matched call to 14678b6eaa6SPeter Maydell * ptimer_transaction_commit(). 14778b6eaa6SPeter Maydell * It is an error to call this function for a BH-based ptimer; 14878b6eaa6SPeter Maydell * attempting to do this will trigger an assert. 14978b6eaa6SPeter Maydell */ 15078b6eaa6SPeter Maydell void ptimer_transaction_begin(ptimer_state *s); 15178b6eaa6SPeter Maydell 15278b6eaa6SPeter Maydell /** 15378b6eaa6SPeter Maydell * ptimer_transaction_commit() - Commit a ptimer modification transaction 15478b6eaa6SPeter Maydell * 15578b6eaa6SPeter Maydell * This function must be called after calls to functions which modify 15678b6eaa6SPeter Maydell * the ptimer's state, and completes the update of the ptimer. If the 15778b6eaa6SPeter Maydell * ptimer state now means that we should trigger the timer expiry 15878b6eaa6SPeter Maydell * callback, it will be called directly. 15978b6eaa6SPeter Maydell */ 16078b6eaa6SPeter Maydell void ptimer_transaction_commit(ptimer_state *s); 16178b6eaa6SPeter Maydell 16278b6eaa6SPeter Maydell /** 163a7a305aeSPeter Maydell * ptimer_set_period - Set counter increment interval in nanoseconds 164a7a305aeSPeter Maydell * @s: ptimer to configure 165a7a305aeSPeter Maydell * @period: period of the counter in nanoseconds 166a7a305aeSPeter Maydell * 167a7a305aeSPeter Maydell * Note that if your counter behaviour is specified as having a 168a7a305aeSPeter Maydell * particular frequency rather than a period then ptimer_set_freq() 169a7a305aeSPeter Maydell * may be more appropriate. 17078b6eaa6SPeter Maydell * 17178b6eaa6SPeter Maydell * This function will assert if it is called outside a 172af2a580fSPeter Maydell * ptimer_transaction_begin/commit block. 173a7a305aeSPeter Maydell */ 1740d09e41aSPaolo Bonzini void ptimer_set_period(ptimer_state *s, int64_t period); 175a7a305aeSPeter Maydell 176a7a305aeSPeter Maydell /** 177ad140dadSPeter Maydell * ptimer_set_period_from_clock - Set counter increment from a Clock 178ad140dadSPeter Maydell * @s: ptimer to configure 179ad140dadSPeter Maydell * @clk: pointer to Clock object to take period from 180ad140dadSPeter Maydell * @divisor: value to scale the clock frequency down by 181ad140dadSPeter Maydell * 182ad140dadSPeter Maydell * If the ptimer is being driven from a Clock, this is the preferred 183ad140dadSPeter Maydell * way to tell the ptimer about the period, because it avoids any 184ad140dadSPeter Maydell * possible rounding errors that might happen if the internal 185ad140dadSPeter Maydell * representation of the Clock period was converted to either a period 186ad140dadSPeter Maydell * in ns or a frequency in Hz. 187ad140dadSPeter Maydell * 188ad140dadSPeter Maydell * If the ptimer should run at the same frequency as the clock, 189ad140dadSPeter Maydell * pass 1 as the @divisor; if the ptimer should run at half the 190ad140dadSPeter Maydell * frequency, pass 2, and so on. 191ad140dadSPeter Maydell * 192ad140dadSPeter Maydell * This function will assert if it is called outside a 193ad140dadSPeter Maydell * ptimer_transaction_begin/commit block. 194ad140dadSPeter Maydell */ 195ad140dadSPeter Maydell void ptimer_set_period_from_clock(ptimer_state *s, const Clock *clock, 196ad140dadSPeter Maydell unsigned int divisor); 197ad140dadSPeter Maydell 198ad140dadSPeter Maydell /** 199a7a305aeSPeter Maydell * ptimer_set_freq - Set counter frequency in Hz 200a7a305aeSPeter Maydell * @s: ptimer to configure 201a7a305aeSPeter Maydell * @freq: counter frequency in Hz 202a7a305aeSPeter Maydell * 203a7a305aeSPeter Maydell * This does the same thing as ptimer_set_period(), so you only 204a7a305aeSPeter Maydell * need to call one of them. If the counter behaviour is specified 205a7a305aeSPeter Maydell * as setting the frequency then this function is more appropriate, 206a7a305aeSPeter Maydell * because it allows specifying an effective period which is 207a7a305aeSPeter Maydell * precise to fractions of a nanosecond, avoiding rounding errors. 20878b6eaa6SPeter Maydell * 20978b6eaa6SPeter Maydell * This function will assert if it is called outside a 210af2a580fSPeter Maydell * ptimer_transaction_begin/commit block. 211a7a305aeSPeter Maydell */ 2120d09e41aSPaolo Bonzini void ptimer_set_freq(ptimer_state *s, uint32_t freq); 213a7a305aeSPeter Maydell 214a7a305aeSPeter Maydell /** 215a7a305aeSPeter Maydell * ptimer_get_limit - Get the configured limit of the ptimer 216a7a305aeSPeter Maydell * @s: ptimer to query 217a7a305aeSPeter Maydell * 218a7a305aeSPeter Maydell * This function returns the current limit (reload) value 219a7a305aeSPeter Maydell * of the down-counter; that is, the value which it will be 220a7a305aeSPeter Maydell * reset to when it hits zero. 221a7a305aeSPeter Maydell * 222a7a305aeSPeter Maydell * Generally timer devices using ptimers should be able to keep 223a7a305aeSPeter Maydell * their reload register state inside the ptimer using the get 224a7a305aeSPeter Maydell * and set limit functions rather than needing to also track it 225a7a305aeSPeter Maydell * in their own state structure. 226a7a305aeSPeter Maydell */ 227578c4b2fSDmitry Osipenko uint64_t ptimer_get_limit(ptimer_state *s); 228a7a305aeSPeter Maydell 229a7a305aeSPeter Maydell /** 230a7a305aeSPeter Maydell * ptimer_set_limit - Set the limit of the ptimer 231a7a305aeSPeter Maydell * @s: ptimer 232a7a305aeSPeter Maydell * @limit: initial countdown value 233a7a305aeSPeter Maydell * @reload: if nonzero, then reset the counter to the new limit 234a7a305aeSPeter Maydell * 235a7a305aeSPeter Maydell * Set the limit value of the down-counter. The @reload flag can 236a7a305aeSPeter Maydell * be used to emulate the behaviour of timers which immediately 237a7a305aeSPeter Maydell * reload the counter when their reload register is written to. 23878b6eaa6SPeter Maydell * 23978b6eaa6SPeter Maydell * This function will assert if it is called outside a 240af2a580fSPeter Maydell * ptimer_transaction_begin/commit block. 241a7a305aeSPeter Maydell */ 2420d09e41aSPaolo Bonzini void ptimer_set_limit(ptimer_state *s, uint64_t limit, int reload); 243a7a305aeSPeter Maydell 244a7a305aeSPeter Maydell /** 245a7a305aeSPeter Maydell * ptimer_get_count - Get the current value of the ptimer 246a7a305aeSPeter Maydell * @s: ptimer 247a7a305aeSPeter Maydell * 248a7a305aeSPeter Maydell * Return the current value of the down-counter. This will 249a7a305aeSPeter Maydell * return the correct value whether the counter is enabled or 250a7a305aeSPeter Maydell * disabled. 251a7a305aeSPeter Maydell */ 2520d09e41aSPaolo Bonzini uint64_t ptimer_get_count(ptimer_state *s); 253a7a305aeSPeter Maydell 254a7a305aeSPeter Maydell /** 255a7a305aeSPeter Maydell * ptimer_set_count - Set the current value of the ptimer 256a7a305aeSPeter Maydell * @s: ptimer 257a7a305aeSPeter Maydell * @count: count value to set 258a7a305aeSPeter Maydell * 259a7a305aeSPeter Maydell * Set the value of the down-counter. If the counter is currently 260a7a305aeSPeter Maydell * enabled this will arrange for a timer callback at the appropriate 261a7a305aeSPeter Maydell * point in the future. 26278b6eaa6SPeter Maydell * 26378b6eaa6SPeter Maydell * This function will assert if it is called outside a 264af2a580fSPeter Maydell * ptimer_transaction_begin/commit block. 265a7a305aeSPeter Maydell */ 2660d09e41aSPaolo Bonzini void ptimer_set_count(ptimer_state *s, uint64_t count); 267a7a305aeSPeter Maydell 268a7a305aeSPeter Maydell /** 269a7a305aeSPeter Maydell * ptimer_run - Start a ptimer counting 270a7a305aeSPeter Maydell * @s: ptimer 271a7a305aeSPeter Maydell * @oneshot: non-zero if this timer should only count down once 272a7a305aeSPeter Maydell * 273af2a580fSPeter Maydell * Start a ptimer counting down; when it reaches zero the callback function 274af2a580fSPeter Maydell * passed to ptimer_init() will be invoked. 275b0142262SPeter Maydell * If the @oneshot argument is zero, 276a7a305aeSPeter Maydell * the counter value will then be reloaded from the limit and it will 277a7a305aeSPeter Maydell * start counting down again. If @oneshot is non-zero, then the counter 278a7a305aeSPeter Maydell * will disable itself when it reaches zero. 27978b6eaa6SPeter Maydell * 28078b6eaa6SPeter Maydell * This function will assert if it is called outside a 281af2a580fSPeter Maydell * ptimer_transaction_begin/commit block. 282a7a305aeSPeter Maydell */ 2830d09e41aSPaolo Bonzini void ptimer_run(ptimer_state *s, int oneshot); 284a7a305aeSPeter Maydell 285a7a305aeSPeter Maydell /** 286a7a305aeSPeter Maydell * ptimer_stop - Stop a ptimer counting 287a7a305aeSPeter Maydell * @s: ptimer 288a7a305aeSPeter Maydell * 289a7a305aeSPeter Maydell * Pause a timer (the count stays at its current value until ptimer_run() 290a7a305aeSPeter Maydell * is called to start it counting again). 291a7a305aeSPeter Maydell * 292a7a305aeSPeter Maydell * Note that this can cause it to "lose" time, even if it is immediately 293a7a305aeSPeter Maydell * restarted. 29478b6eaa6SPeter Maydell * 29578b6eaa6SPeter Maydell * This function will assert if it is called outside a 296af2a580fSPeter Maydell * ptimer_transaction_begin/commit block. 297a7a305aeSPeter Maydell */ 2980d09e41aSPaolo Bonzini void ptimer_stop(ptimer_state *s); 2990d09e41aSPaolo Bonzini 3000d09e41aSPaolo Bonzini extern const VMStateDescription vmstate_ptimer; 3010d09e41aSPaolo Bonzini 30220bcf73fSPeter Maydell #define VMSTATE_PTIMER(_field, _state) \ 30320bcf73fSPeter Maydell VMSTATE_STRUCT_POINTER_V(_field, _state, 1, vmstate_ptimer, ptimer_state) 3040d09e41aSPaolo Bonzini 305a1f05e79SPeter Maydell #define VMSTATE_PTIMER_ARRAY(_f, _s, _n) \ 306a1f05e79SPeter Maydell VMSTATE_ARRAY_OF_POINTER_TO_STRUCT(_f, _s, _n, 0, \ 307a1f05e79SPeter Maydell vmstate_ptimer, ptimer_state) 308a1f05e79SPeter Maydell 3090d09e41aSPaolo Bonzini #endif 310