include/linux/nfc.h

   1 /*
   2  * Copyright (C) 2011 Instituto Nokia de Tecnologia
   3  *
   4  * Authors:
   5  *    Lauro Ramos Venancio <lauro.venancio@openbossa.org>
   6  *    Aloisio Almeida Jr <aloisio.almeida@openbossa.org>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the
  20  * Free Software Foundation, Inc.,
  21  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  22  */
  23
  24 #ifndef __LINUX_NFC_H
  25 #define __LINUX_NFC_H
  26
  27 #include <linux/types.h>
  28 #include <linux/socket.h>
  29
  30 #define NFC_GENL_NAME "nfc"
  31 #define NFC_GENL_VERSION 1
  32
  33 #define NFC_GENL_MCAST_EVENT_NAME "events"
  34
  35 /**
  36  * enum nfc_commands - supported nfc commands
  37  *
  38  * @NFC_CMD_UNSPEC: unspecified command
  39  *
  40  * @NFC_CMD_GET_DEVICE: request information about a device (requires
  41  *      %NFC_ATTR_DEVICE_INDEX) or dump request to get a list of all nfc devices
  42  * @NFC_CMD_DEV_UP: turn on the nfc device
  43  *      (requires %NFC_ATTR_DEVICE_INDEX)
  44  * @NFC_CMD_DEV_DOWN: turn off the nfc device
  45  *      (requires %NFC_ATTR_DEVICE_INDEX)
  46  * @NFC_CMD_START_POLL: start polling for targets using the given protocols
  47  *      (requires %NFC_ATTR_DEVICE_INDEX and %NFC_ATTR_PROTOCOLS)
  48  * @NFC_CMD_STOP_POLL: stop polling for targets (requires
  49  *      %NFC_ATTR_DEVICE_INDEX)
  50  * @NFC_CMD_GET_TARGET: dump all targets found by the previous poll (requires
  51  *      %NFC_ATTR_DEVICE_INDEX)
  52  * @NFC_EVENT_TARGETS_FOUND: event emitted when a new target is found
  53  *      (it sends %NFC_ATTR_DEVICE_INDEX)
  54  * @NFC_EVENT_DEVICE_ADDED: event emitted when a new device is registred
  55  *      (it sends %NFC_ATTR_DEVICE_NAME, %NFC_ATTR_DEVICE_INDEX and
  56  *      %NFC_ATTR_PROTOCOLS)
  57  * @NFC_EVENT_DEVICE_REMOVED: event emitted when a device is removed
  58  *      (it sends %NFC_ATTR_DEVICE_INDEX)
  59  */
  60 enum nfc_commands {
  61         NFC_CMD_UNSPEC,
  62         NFC_CMD_GET_DEVICE,
  63         NFC_CMD_DEV_UP,
  64         NFC_CMD_DEV_DOWN,
  65         NFC_CMD_START_POLL,
  66         NFC_CMD_STOP_POLL,
  67         NFC_CMD_GET_TARGET,
  68         NFC_EVENT_TARGETS_FOUND,
  69         NFC_EVENT_DEVICE_ADDED,
  70         NFC_EVENT_DEVICE_REMOVED,
  71 /* private: internal use only */
  72         __NFC_CMD_AFTER_LAST
  73 };
  74 #define NFC_CMD_MAX (__NFC_CMD_AFTER_LAST - 1)
  75
  76 /**
  77  * enum nfc_attrs - supported nfc attributes
  78  *
  79  * @NFC_ATTR_UNSPEC: unspecified attribute
  80  *
  81  * @NFC_ATTR_DEVICE_INDEX: index of nfc device
  82  * @NFC_ATTR_DEVICE_NAME: device name, max 8 chars
  83  * @NFC_ATTR_PROTOCOLS: nfc protocols - bitwise or-ed combination from
  84  *      NFC_PROTO_*_MASK constants
  85  * @NFC_ATTR_TARGET_INDEX: index of the nfc target
  86  * @NFC_ATTR_TARGET_SENS_RES: NFC-A targets extra information such as NFCID
  87  * @NFC_ATTR_TARGET_SEL_RES: NFC-A targets extra information (useful if the
  88  *      target is not NFC-Forum compliant)
  89  */
  90 enum nfc_attrs {
  91         NFC_ATTR_UNSPEC,
  92         NFC_ATTR_DEVICE_INDEX,
  93         NFC_ATTR_DEVICE_NAME,
  94         NFC_ATTR_PROTOCOLS,
  95         NFC_ATTR_TARGET_INDEX,
  96         NFC_ATTR_TARGET_SENS_RES,
  97         NFC_ATTR_TARGET_SEL_RES,
  98 /* private: internal use only */
  99         __NFC_ATTR_AFTER_LAST
 100 };
 101 #define NFC_ATTR_MAX (__NFC_ATTR_AFTER_LAST - 1)
 102
 103 #define NFC_DEVICE_NAME_MAXSIZE 8
 104
 105 /* NFC protocols */
 106 #define NFC_PROTO_JEWEL         1
 107 #define NFC_PROTO_MIFARE        2
 108 #define NFC_PROTO_FELICA        3
 109 #define NFC_PROTO_ISO14443      4
 110 #define NFC_PROTO_NFC_DEP       5
 111
 112 #define NFC_PROTO_MAX           6
 113
 114 /* NFC protocols masks used in bitsets */
 115 #define NFC_PROTO_JEWEL_MASK    (1 << NFC_PROTO_JEWEL)
 116 #define NFC_PROTO_MIFARE_MASK   (1 << NFC_PROTO_MIFARE)
 117 #define NFC_PROTO_FELICA_MASK   (1 << NFC_PROTO_FELICA)
 118 #define NFC_PROTO_ISO14443_MASK (1 << NFC_PROTO_ISO14443)
 119 #define NFC_PROTO_NFC_DEP_MASK  (1 << NFC_PROTO_NFC_DEP)
 120
 121 struct sockaddr_nfc {
 122         sa_family_t sa_family;
 123         __u32 dev_idx;
 124         __u32 target_idx;
 125         __u32 nfc_protocol;
 126 };
 127
 128 /* NFC socket protocols */
 129 #define NFC_SOCKPROTO_RAW       0
 130 #define NFC_SOCKPROTO_MAX       1
 131
 132 #define NFC_HEADER_SIZE 1
 133
 134 #endif /*__LINUX_NFC_H */