sys/dev/fdt/fdt_clock.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 ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  * $FreeBSD$
  26  */
  27
  28 #ifndef DEV_FDT_CLOCK_H
  29 #define DEV_FDT_CLOCK_H
  30
  31 #include "fdt_clock_if.h"
  32
  33 /*
  34  * Get info about the Nth clock listed in consumer's "clocks" property.
  35  *
  36  * Returns 0 on success, ENXIO if clock #n not found.
  37  */
  38 int fdt_clock_get_info(device_t consumer, int n, struct fdt_clock_info *info);
  39
  40 /*
  41  * Look up "clocks" property in consumer's fdt data and enable or disable all
  42  * configured clocks.
  43  */
  44 int fdt_clock_enable_all(device_t consumer);
  45 int fdt_clock_disable_all(device_t consumer);
  46
  47 /*
  48  * [Un]register the given device instance as a driver that implements the
  49  * fdt_clock interface.
  50  */
  51 void fdt_clock_register_provider(device_t provider);
  52 void fdt_clock_unregister_provider(device_t provider);
  53
  54 #endif /* DEV_FDT_CLOCK_H */
  55