nfc.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  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. #ifndef __NET_NFC_H
  24. #define __NET_NFC_H
  25. #include <linux/nfc.h>
  26. #include <linux/device.h>
  27. #include <linux/skbuff.h>
  28. #define nfc_dev_info(dev, fmt, arg...) dev_info((dev), "NFC: " fmt "\n", ## arg)
  29. #define nfc_dev_err(dev, fmt, arg...) dev_err((dev), "NFC: " fmt "\n", ## arg)
  30. #define nfc_dev_dbg(dev, fmt, arg...) dev_dbg((dev), fmt "\n", ## arg)
  31. struct nfc_dev;
  32. /**
  33. * data_exchange_cb_t - Definition of nfc_data_exchange callback
  34. *
  35. * @context: nfc_data_exchange cb_context parameter
  36. * @skb: response data
  37. * @err: If an error has occurred during data exchange, it is the
  38. * error number. Zero means no error.
  39. *
  40. * When a rx or tx package is lost or corrupted or the target gets out
  41. * of the operating field, err is -EIO.
  42. */
  43. typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
  44. int err);
  45. struct nfc_target;
  46. struct nfc_ops {
  47. int (*dev_up)(struct nfc_dev *dev);
  48. int (*dev_down)(struct nfc_dev *dev);
  49. int (*start_poll)(struct nfc_dev *dev,
  50. u32 im_protocols, u32 tm_protocols);
  51. void (*stop_poll)(struct nfc_dev *dev);
  52. int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target,
  53. u8 comm_mode, u8 *gb, size_t gb_len);
  54. int (*dep_link_down)(struct nfc_dev *dev);
  55. int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target,
  56. u32 protocol);
  57. void (*deactivate_target)(struct nfc_dev *dev,
  58. struct nfc_target *target);
  59. int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target,
  60. struct sk_buff *skb, data_exchange_cb_t cb,
  61. void *cb_context);
  62. int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb);
  63. int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target);
  64. int (*fw_upload)(struct nfc_dev *dev, const char *firmware_name);
  65. /* Secure Element API */
  66. int (*discover_se)(struct nfc_dev *dev);
  67. int (*enable_se)(struct nfc_dev *dev, u32 se_idx);
  68. int (*disable_se)(struct nfc_dev *dev, u32 se_idx);
  69. };
  70. #define NFC_TARGET_IDX_ANY -1
  71. #define NFC_MAX_GT_LEN 48
  72. #define NFC_ATR_RES_GT_OFFSET 15
  73. struct nfc_target {
  74. u32 idx;
  75. u32 supported_protocols;
  76. u16 sens_res;
  77. u8 sel_res;
  78. u8 nfcid1_len;
  79. u8 nfcid1[NFC_NFCID1_MAXSIZE];
  80. u8 nfcid2_len;
  81. u8 nfcid2[NFC_NFCID2_MAXSIZE];
  82. u8 sensb_res_len;
  83. u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
  84. u8 sensf_res_len;
  85. u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
  86. u8 hci_reader_gate;
  87. u8 logical_idx;
  88. };
  89. /**
  90. * nfc_se - A structure for NFC accessible secure elements.
  91. *
  92. * @idx: The secure element index. User space will enable or
  93. * disable a secure element by its index.
  94. * @type: The secure element type. It can be SE_UICC or
  95. * SE_EMBEDDED.
  96. * @state: The secure element state, either enabled or disabled.
  97. *
  98. */
  99. struct nfc_se {
  100. struct list_head list;
  101. u32 idx;
  102. u16 type;
  103. u16 state;
  104. };
  105. struct nfc_genl_data {
  106. u32 poll_req_portid;
  107. struct mutex genl_data_mutex;
  108. };
  109. struct nfc_dev {
  110. int idx;
  111. u32 target_next_idx;
  112. struct nfc_target *targets;
  113. int n_targets;
  114. int targets_generation;
  115. struct device dev;
  116. bool dev_up;
  117. bool fw_upload_in_progress;
  118. u8 rf_mode;
  119. bool polling;
  120. struct nfc_target *active_target;
  121. bool dep_link_up;
  122. struct nfc_genl_data genl_data;
  123. u32 supported_protocols;
  124. struct list_head secure_elements;
  125. int tx_headroom;
  126. int tx_tailroom;
  127. struct timer_list check_pres_timer;
  128. struct work_struct check_pres_work;
  129. bool shutting_down;
  130. struct rfkill *rfkill;
  131. struct nfc_ops *ops;
  132. };
  133. #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
  134. extern struct class nfc_class;
  135. struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
  136. u32 supported_protocols,
  137. int tx_headroom,
  138. int tx_tailroom);
  139. /**
  140. * nfc_free_device - free nfc device
  141. *
  142. * @dev: The nfc device to free
  143. */
  144. static inline void nfc_free_device(struct nfc_dev *dev)
  145. {
  146. put_device(&dev->dev);
  147. }
  148. int nfc_register_device(struct nfc_dev *dev);
  149. void nfc_unregister_device(struct nfc_dev *dev);
  150. /**
  151. * nfc_set_parent_dev - set the parent device
  152. *
  153. * @nfc_dev: The nfc device whose parent is being set
  154. * @dev: The parent device
  155. */
  156. static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
  157. struct device *dev)
  158. {
  159. nfc_dev->dev.parent = dev;
  160. }
  161. /**
  162. * nfc_set_drvdata - set driver specifc data
  163. *
  164. * @dev: The nfc device
  165. * @data: Pointer to driver specifc data
  166. */
  167. static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
  168. {
  169. dev_set_drvdata(&dev->dev, data);
  170. }
  171. /**
  172. * nfc_get_drvdata - get driver specifc data
  173. *
  174. * @dev: The nfc device
  175. */
  176. static inline void *nfc_get_drvdata(struct nfc_dev *dev)
  177. {
  178. return dev_get_drvdata(&dev->dev);
  179. }
  180. /**
  181. * nfc_device_name - get the nfc device name
  182. *
  183. * @dev: The nfc device whose name to return
  184. */
  185. static inline const char *nfc_device_name(struct nfc_dev *dev)
  186. {
  187. return dev_name(&dev->dev);
  188. }
  189. struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
  190. unsigned int flags, unsigned int size,
  191. unsigned int *err);
  192. struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
  193. int nfc_set_remote_general_bytes(struct nfc_dev *dev,
  194. u8 *gt, u8 gt_len);
  195. u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);
  196. int nfc_targets_found(struct nfc_dev *dev,
  197. struct nfc_target *targets, int ntargets);
  198. int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
  199. int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
  200. u8 comm_mode, u8 rf_mode);
  201. int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
  202. u8 *gb, size_t gb_len);
  203. int nfc_tm_deactivated(struct nfc_dev *dev);
  204. int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);
  205. void nfc_driver_failure(struct nfc_dev *dev, int err);
  206. int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type);
  207. int nfc_remove_se(struct nfc_dev *dev, u32 se_idx);
  208. #endif /* __NET_NFC_H */