drivers/w1/w1_family.h

   1 /*
   2  * Copyright (c) 2004 Evgeniy Polyakov <zbr@ioremap.net>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  */
  14
  15 #ifndef __W1_FAMILY_H
  16 #define __W1_FAMILY_H
  17
  18 #include <linux/types.h>
  19 #include <linux/device.h>
  20 #include <linux/atomic.h>
  21
  22 #define W1_FAMILY_DEFAULT       0
  23 #define W1_FAMILY_BQ27000       0x01
  24 #define W1_FAMILY_SMEM_01       0x01
  25 #define W1_FAMILY_SMEM_81       0x81
  26 #define W1_FAMILY_DS2405        0x05
  27 #define W1_THERM_DS18S20        0x10
  28 #define W1_FAMILY_DS28E04       0x1C
  29 #define W1_COUNTER_DS2423       0x1D
  30 #define W1_THERM_DS1822         0x22
  31 #define W1_EEPROM_DS2433        0x23
  32 #define W1_FAMILY_DS2438        0x26
  33 #define W1_THERM_DS18B20        0x28
  34 #define W1_FAMILY_DS2408        0x29
  35 #define W1_EEPROM_DS2431        0x2D
  36 #define W1_FAMILY_DS2760        0x30
  37 #define W1_FAMILY_DS2780        0x32
  38 #define W1_FAMILY_DS2413        0x3A
  39 #define W1_FAMILY_DS2406        0x12
  40 #define W1_THERM_DS1825         0x3B
  41 #define W1_FAMILY_DS2781        0x3D
  42 #define W1_THERM_DS28EA00       0x42
  43
  44 #define MAXNAMELEN              32
  45
  46 struct w1_slave;
  47
  48 /**
  49  * struct w1_family_ops - operations for a family type
  50  * @add_slave: add_slave
  51  * @remove_slave: remove_slave
  52  * @groups: sysfs group
  53  */
  54 struct w1_family_ops
  55 {
  56         int  (* add_slave)(struct w1_slave *);
  57         void (* remove_slave)(struct w1_slave *);
  58         const struct attribute_group **groups;
  59 };
  60
  61 /**
  62  * struct w1_family - reference counted family structure.
  63  * @family_entry:       family linked list
  64  * @fid:                8 bit family identifier
  65  * @fops:               operations for this family
  66  * @refcnt:             reference counter
  67  */
  68 struct w1_family
  69 {
  70         struct list_head        family_entry;
  71         u8                      fid;
  72
  73         struct w1_family_ops    *fops;
  74
  75         atomic_t                refcnt;
  76 };
  77
  78 extern spinlock_t w1_flock;
  79
  80 void w1_family_put(struct w1_family *);
  81 void __w1_family_get(struct w1_family *);
  82 struct w1_family * w1_family_registered(u8);
  83 void w1_unregister_family(struct w1_family *);
  84 int w1_register_family(struct w1_family *);
  85
  86 /**
  87  * module_w1_driver() - Helper macro for registering a 1-Wire families
  88  * @__w1_family: w1_family struct
  89  *
  90  * Helper macro for 1-Wire families which do not do anything special in module
  91  * init/exit. This eliminates a lot of boilerplate. Each module may only
  92  * use this macro once, and calling it replaces module_init() and module_exit()
  93  */
  94 #define module_w1_family(__w1_family) \
  95         module_driver(__w1_family, w1_register_family, \
  96                         w1_unregister_family)
  97
  98 #endif /* __W1_FAMILY_H */