sys/dev/extres/hwreset/hwreset_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 #ifdef FDT
  30 #include <sys/types.h>
  31 #include <dev/ofw/ofw_bus.h>
  32 #endif
  33
  34 INTERFACE hwreset;
  35
  36 #ifdef FDT
  37 HEADER {
  38 int hwreset_default_ofw_map(device_t , phandle_t, int, pcell_t *, intptr_t *);
  39 }
  40
  41 #
  42 # map fdt property cells to reset id
  43 # Returns 0 on success or a standard errno value.
  44 #
  45 METHOD int map {
  46         device_t        provider_dev;
  47         phandle_t       xref;
  48         int             ncells;
  49         pcell_t         *cells;
  50         intptr_t        *id;
  51 } DEFAULT hwreset_default_ofw_map;
  52 #endif
  53
  54 #
  55 # Assert/deassert given reset.
  56 # Returns 0 on success or a standard errno value.
  57 #
  58 METHOD int assert {
  59         device_t        provider_dev;
  60         intptr_t        id;
  61         bool            value;
  62 };
  63
  64 #
  65 # Get actual status of given reset.
  66 # Returns 0 on success or a standard errno value.
  67 #
  68 METHOD int is_asserted {
  69         device_t        provider_dev;
  70         intptr_t        id;
  71         bool            *value;
  72 };