sys/dev/ow/own_if.m

   1 #-
   2 # Copyright (c) 2015 M. Warner Losh <imp@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 #include <sys/bus.h>
  30 #include <dev/ow/ow.h>
  31
  32 INTERFACE own;
  33
  34 #
  35 # Dallas Semiconductor 1-Wire bus network and transport layer (own)
  36 #
  37 # See Maxim Application Note AN937: Book of iButton Standards for the
  38 # 1-Wire protocol specification.
  39 # http://pdfserv.maximintegrated.com/en/an/AN937.pdf
  40 #
  41 # Note: 1-Wire is a registered trademark of Maxim Integrated Products, Inc.
  42 #
  43
  44 #
  45 # Send a command up the stack.
  46 #
  47 METHOD int send_command {
  48         device_t        ndev;           /* Network (bus) level device */
  49         device_t        pdev;           /* Device to send command for */
  50         struct ow_cmd   *cmd;           /* Pointer to filled in command */
  51 };
  52
  53 #
  54 # Grab exclusive use of the bus (advisory)
  55 #
  56 METHOD int acquire_bus {
  57         device_t        ndev;
  58         device_t        pdev;
  59         int             how;
  60 };
  61
  62 #
  63 # Release exclusive use of the bus (advisory)
  64 #
  65 METHOD void release_bus {
  66         device_t        ndev;
  67         device_t        pdev;
  68 };
  69
  70 #
  71 # Compute a CRC for a given range of bytes
  72 #
  73 METHOD uint8_t crc {
  74         device_t        ndev;
  75         device_t        pdev;
  76         uint8_t         *buffer;
  77         size_t          len;
  78 };