NFC: Document NFC targets sens_res field

SENS_RES has no specific endiannes attached to it, the kernel ABI is the
following one: Byte 2 (As described by the NFC Forum Digital spec) is
the u16 most significant byte.

Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>

diff --git a/include/net/nfc/nfc.h b/include/net/nfc/nfc.h
index c2aee4875b6562db2ec64b7a8c2f7b17ca1b6408..5329804ebb704baef6e111ce730fcfe5d5345505 100644 (file)
--- a/include/net/nfc/nfc.h
+++ b/include/net/nfc/nfc.h
@@ -85,6 +85,14 @@ struct nfc_ops {
 #define NFC_MAX_GT_LEN 48
 #define NFC_ATR_RES_GT_OFFSET 15
 
+/**
+ * struct nfc_target - NFC target descriptiom
+ *
+ * @sens_res: 2 bytes describing the target SENS_RES response, if the target
+ *     is a type A one. The %sens_res most significant byte must be byte 2
+ *     as described by the NFC Forum digital specification (i.e. the platform
+ *     configuration one) while %sens_res least significant byte is byte 1.
+ */
 struct nfc_target {
        u32 idx;
        u32 supported_protocols;