sys/dev/ow/own_if.m

   1 #-
   2 # Copyright (c) 2015 M. Warner Losh <imp@FreeBSD.org>
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions
   6 # are met:
   7 # 1. Redistributions of source code must retain the above copyright
   8 #    notice, this list of conditions and the following disclaimer.
   9 # 2. Redistributions in binary form must reproduce the above copyright
  10 #    notice, this list of conditions and the following disclaimer in the
  11 #    documentation and/or other materials provided with the distribution.
  12 #
  13 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 # SUCH DAMAGE.
  24 #
  25 # $FreeBSD$
  26 #
  27
  28 #include <sys/bus.h>
  29 #include <dev/ow/ow.h>
  30
  31 INTERFACE own;
  32
  33 #
  34 # Dallas Semiconductor 1-Wire bus network and transport layer (own)
  35 #
  36 # See Maxim Application Note AN937: Book of iButton Standards for the
  37 # 1-Wire protocol specification.
  38 # http://pdfserv.maximintegrated.com/en/an/AN937.pdf
  39 #
  40 # Note: 1-Wire is a registered trademark of Maxim Integrated Products, Inc.
  41 #
  42
  43 #
  44 # Send a command up the stack.
  45 #
  46 METHOD int send_command {
  47         device_t        ndev;           /* Network (bus) level device */
  48         device_t        pdev;           /* Device to send command for */
  49         struct ow_cmd   *cmd;           /* Pointer to filled in command */
  50 };
  51
  52 #
  53 # Grab exclusive use of the bus (advisory)
  54 #
  55 METHOD int acquire_bus {
  56         device_t        ndev;
  57         device_t        pdev;
  58         int             how;
  59 };
  60
  61 #
  62 # Release exclusive use of the bus (advisory)
  63 #
  64 METHOD void release_bus {
  65         device_t        ndev;
  66         device_t        pdev;
  67 };
  68
  69 #
  70 # Compute a CRC for a given range of bytes
  71 #
  72 METHOD uint8_t crc {
  73         device_t        ndev;
  74         device_t        pdev;
  75         uint8_t         *buffer;
  76         size_t          len;
  77 };