sys/dev/extres/clk/clknode_if.m

   1 #-
   2 # Copyright 2016 Michal Meloun <mmel@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 INTERFACE clknode;
  30
  31 HEADER {
  32         struct clknode;
  33 }
  34
  35 #
  36 # Initialize clock node, get shanpshot of cached values
  37 #
  38 METHOD int init {
  39         struct clknode  *clk;
  40         device_t        dev;
  41 };
  42
  43 #
  44 # Recalculate frequency
  45 #     req - in/out recalulated frequency
  46 #
  47 METHOD int recalc_freq {
  48         struct clknode  *clk;
  49         uint64_t        *freq;
  50 };
  51
  52 #
  53 # Set frequency
  54 #     fin - parent (input)frequency.
  55 #     fout - requested output freqency. If clock cannot change frequency,
  56 #           then must return new requested frequency for his parent
  57 METHOD int set_freq {
  58         struct clknode  *clk;
  59         uint64_t        fin;
  60         uint64_t        *fout;
  61         int             flags;
  62         int             *done;
  63 };
  64
  65 #
  66 # Enable/disable clock
  67 #
  68 METHOD int set_gate {
  69         struct clknode  *clk;
  70         bool            enable;
  71 };
  72
  73 #
  74 # Set multiplexer
  75 #
  76 METHOD int set_mux {
  77         struct clknode  *clk;
  78         int             idx;
  79 };