sys/arm/arm/mpcore_timervar.h

   1 /*-
   2  * Copyright (c) 2014 Ian Lepore <ian@freebsd.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _ARM_MPCORE_TIMERVAR_H_
  30 #define _ARM_MPCORE_TIMERVAR_H_
  31
  32 /*
  33  * This value, passed to arm_tmr_change_frequency() any time before the mpcore
  34  * timer device attaches, informs the driver that the mpcore clock frequency can
  35  * change on the fly, and thus can't be used as a timecounter.  The hardware can
  36  * still be used as an eventtimer, as long as each frequency change is
  37  * communicated to it with calls to arm_tmr_change_frequency().
  38  */
  39 #define ARM_TMR_FREQUENCY_VARIES        -1ULL
  40
  41 /*
  42  * Inform the mpcore timer driver of a new clock frequency.  This can be called
  43  * both before and after the mpcore timer driver attaches.
  44  */
  45 void arm_tmr_change_frequency(uint64_t newfreq);
  46
  47 #endif