144ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen/* 21c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * Copyright (C) 2011, 2012 The Android Open Source Project 344ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * 444ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * Licensed under the Apache License, Version 2.0 (the "License"); 544ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * you may not use this file except in compliance with the License. 644ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * You may obtain a copy of the License at 744ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * 844ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * http://www.apache.org/licenses/LICENSE-2.0 944ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * 1044ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * Unless required by applicable law or agreed to in writing, software 1144ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * distributed under the License is distributed on an "AS IS" BASIS, 1244ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1344ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * See the License for the specific language governing permissions and 1444ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * limitations under the License. 1544ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen */ 1644ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 1744ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen#ifndef ANDROID_NFC_HAL_INTERFACE_H 1844ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen#define ANDROID_NFC_HAL_INTERFACE_H 1944ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 2044ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen#include <stdint.h> 2144ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen#include <strings.h> 2244ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen#include <sys/cdefs.h> 2344ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen#include <sys/types.h> 2444ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 2544ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen#include <hardware/hardware.h> 2644ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 2744ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen__BEGIN_DECLS 2844ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 291c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 301c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen/* NFC device HAL for NCI-based NFC controllers. 311c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 321c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * This HAL allows NCI silicon vendors to make use 331c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * of the core NCI stack in Android for their own silicon. 341c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 351c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * The responibilities of the NCI HAL implementation 361c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * are as follows: 371c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 381c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * - Implement the transport to the NFC controller 391c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * - Implement each of the HAL methods specified below as applicable to their silicon 401c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * - Pass up received NCI messages from the controller to the stack 411c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 421c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * A simplified timeline of NCI HAL method calls: 431c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 1) Core NCI stack calls open() 441c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 2) Core NCI stack executes CORE_RESET and CORE_INIT through calls to write() 451c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 3) Core NCI stack calls core_initialized() to allow HAL to do post-init configuration 461c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 4) Core NCI stack calls pre_discover() to allow HAL to prepare for RF discovery 471c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 5) Core NCI stack starts discovery through calls to write() 481c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 6) Core NCI stack stops discovery through calls to write() (e.g. screen turns off) 491c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 7) Core NCI stack calls pre_discover() to prepare for RF discovery (e.g. screen turned back on) 501c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 8) Core NCI stack starts discovery through calls to write() 511c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * ... 521c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * ... 531c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 9) Core NCI stack calls close() 541c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 551c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen#define NFC_NCI_HARDWARE_MODULE_ID "nfc_nci" 5693cc45750b339fdd027622c91d25da511e77c73eMartijn Coenen#define NFC_NCI_BCM2079X_HARDWARE_MODULE_ID "nfc_nci.bcm2079x" 571c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen#define NFC_NCI_CONTROLLER "nci" 581c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 591c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen/* 601c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * nfc_nci_module_t should contain module-specific parameters 611c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 621c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenentypedef struct nfc_nci_module_t { 63b253bcc44a987b81e427e08a722b3daad5990726Stewart Miles /** 64b253bcc44a987b81e427e08a722b3daad5990726Stewart Miles * Common methods of the NFC NCI module. This *must* be the first member of 65b253bcc44a987b81e427e08a722b3daad5990726Stewart Miles * nfc_nci_module_t as users of this structure will cast a hw_module_t to 66b253bcc44a987b81e427e08a722b3daad5990726Stewart Miles * nfc_nci_module_t pointer in contexts where it's known the hw_module_t references a 67b253bcc44a987b81e427e08a722b3daad5990726Stewart Miles * nfc_nci_module_t. 68b253bcc44a987b81e427e08a722b3daad5990726Stewart Miles */ 691c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen struct hw_module_t common; 701c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen} nfc_nci_module_t; 711c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 721c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen/* 731c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * HAL events that can be passed back to the stack 741c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 751c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenentypedef uint8_t nfc_event_t; 761c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 771c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenenenum { 781c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen HAL_NFC_OPEN_CPLT_EVT = 0x00, 791c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen HAL_NFC_CLOSE_CPLT_EVT = 0x01, 801c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen HAL_NFC_POST_INIT_CPLT_EVT = 0x02, 81442752aecdc54c32e77227e792fca64dcf1c1fb8Martijn Coenen HAL_NFC_PRE_DISCOVER_CPLT_EVT = 0x03, 82442752aecdc54c32e77227e792fca64dcf1c1fb8Martijn Coenen HAL_NFC_REQUEST_CONTROL_EVT = 0x04, 83442752aecdc54c32e77227e792fca64dcf1c1fb8Martijn Coenen HAL_NFC_RELEASE_CONTROL_EVT = 0x05, 84442752aecdc54c32e77227e792fca64dcf1c1fb8Martijn Coenen HAL_NFC_ERROR_EVT = 0x06 851c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen}; 861c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 871c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen/* 881c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * Allowed status return values for each of the HAL methods 891c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 901c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenentypedef uint8_t nfc_status_t; 911c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 921c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenenenum { 931c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen HAL_NFC_STATUS_OK = 0x00, 941c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen HAL_NFC_STATUS_FAILED = 0x01, 951c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen HAL_NFC_STATUS_ERR_TRANSPORT = 0x02, 961c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen HAL_NFC_STATUS_ERR_CMD_TIMEOUT = 0x03, 971c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen HAL_NFC_STATUS_REFUSED = 0x04 981c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen}; 991c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 1001c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen/* 101442752aecdc54c32e77227e792fca64dcf1c1fb8Martijn Coenen * The callback passed in from the NFC stack that the HAL 102442752aecdc54c32e77227e792fca64dcf1c1fb8Martijn Coenen * can use to pass events back to the stack. 1031c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 104442752aecdc54c32e77227e792fca64dcf1c1fb8Martijn Coenentypedef void (nfc_stack_callback_t) (nfc_event_t event, nfc_status_t event_status); 1051c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 1061c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen/* 1071c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * The callback passed in from the NFC stack that the HAL 108442752aecdc54c32e77227e792fca64dcf1c1fb8Martijn Coenen * can use to pass incomming data to the stack. 1091c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 110442752aecdc54c32e77227e792fca64dcf1c1fb8Martijn Coenentypedef void (nfc_stack_data_callback_t) (uint16_t data_len, uint8_t* p_data); 1111c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 1121c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen/* nfc_nci_device_t starts with a hw_device_t struct, 1131c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * followed by device-specific methods and members. 1141c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 1151c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * All methods in the NCI HAL are asynchronous. 1161c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 1171c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenentypedef struct nfc_nci_device { 118b253bcc44a987b81e427e08a722b3daad5990726Stewart Miles /** 119b253bcc44a987b81e427e08a722b3daad5990726Stewart Miles * Common methods of the NFC NCI device. This *must* be the first member of 120b253bcc44a987b81e427e08a722b3daad5990726Stewart Miles * nfc_nci_device_t as users of this structure will cast a hw_device_t to 121b253bcc44a987b81e427e08a722b3daad5990726Stewart Miles * nfc_nci_device_t pointer in contexts where it's known the hw_device_t references a 122b253bcc44a987b81e427e08a722b3daad5990726Stewart Miles * nfc_nci_device_t. 123b253bcc44a987b81e427e08a722b3daad5990726Stewart Miles */ 1241c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen struct hw_device_t common; 1251c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen /* 1261c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * (*open)() Opens the NFC controller device and performs initialization. 1271c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * This may include patch download and other vendor-specific initialization. 1281c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 1291c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * If open completes successfully, the controller should be ready to perform 1301c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * NCI initialization - ie accept CORE_RESET and subsequent commands through 1311c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * the write() call. 1321c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 1331c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * If open() returns 0, the NCI stack will wait for a HAL_NFC_OPEN_CPLT_EVT 1341c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * before continuing. 1351c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 1361c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * If open() returns any other value, the NCI stack will stop. 1371c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 1381c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 139442752aecdc54c32e77227e792fca64dcf1c1fb8Martijn Coenen int (*open)(const struct nfc_nci_device *p_dev, nfc_stack_callback_t *p_cback, 140442752aecdc54c32e77227e792fca64dcf1c1fb8Martijn Coenen nfc_stack_data_callback_t *p_data_cback); 1411c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 1421c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen /* 1431c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * (*write)() Performs an NCI write. 1441c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 1451c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * This method may queue writes and return immediately. The only 1461c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * requirement is that the writes are executed in order. 1471c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 1481c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen int (*write)(const struct nfc_nci_device *p_dev, uint16_t data_len, const uint8_t *p_data); 1491c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 1501c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen /* 1511c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * (*core_initialized)() is called after the CORE_INIT_RSP is received from the NFCC. 1521c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * At this time, the HAL can do any chip-specific configuration. 1531c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 1541c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * If core_initialized() returns 0, the NCI stack will wait for a HAL_NFC_POST_INIT_CPLT_EVT 1551c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * before continuing. 1561c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 1571c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * If core_initialized() returns any other value, the NCI stack will continue 1581c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * immediately. 1591c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 1601c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen int (*core_initialized)(const struct nfc_nci_device *p_dev, uint8_t* p_core_init_rsp_params); 1611c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 1621c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen /* 1631c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * (*pre_discover)() Is called every time before starting RF discovery. 1641c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * It is a good place to do vendor-specific configuration that must be 1651c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * performed every time RF discovery is about to be started. 1661c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 1671c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * If pre_discover() returns 0, the NCI stack will wait for a HAL_NFC_PRE_DISCOVER_CPLT_EVT 1681c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * before continuing. 1691c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 1701c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * If pre_discover() returns any other value, the NCI stack will start 1711c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * RF discovery immediately. 1721c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 1731c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen int (*pre_discover)(const struct nfc_nci_device *p_dev); 1741c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 1751c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen /* 1761c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * (*close)() Closed the NFC controller. Should free all resources. 1771c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 1781c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen int (*close)(const struct nfc_nci_device *p_dev); 1791c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 1801c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen /* 1811c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * (*control_granted)() Grant HAL the exclusive control to send NCI commands. 1821c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * Called in response to HAL_REQUEST_CONTROL_EVT. 1831c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * Must only be called when there are no NCI commands pending. 1841c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * HAL_RELEASE_CONTROL_EVT will notify when HAL no longer needs exclusive control. 1851c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 1861c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen int (*control_granted)(const struct nfc_nci_device *p_dev); 1871c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 1881c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen /* 1891c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * (*power_cycle)() Restart controller by power cyle; 1901c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * HAL_OPEN_CPLT_EVT will notify when operation is complete. 1911c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 1921c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen int (*power_cycle)(const struct nfc_nci_device *p_dev); 1931c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen} nfc_nci_device_t; 1941c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 1951c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen/* 1961c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * Convenience methods that the NFC stack can use to open 1971c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * and close an NCI device 1981c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 1991c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenenstatic inline int nfc_nci_open(const struct hw_module_t* module, 2001c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen nfc_nci_device_t** dev) { 2011c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen return module->methods->open(module, NFC_NCI_CONTROLLER, 2021c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen (struct hw_device_t**) dev); 2031c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen} 2041c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 2051c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenenstatic inline int nfc_nci_close(nfc_nci_device_t* dev) { 2061c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen return dev->common.close(&dev->common); 2071c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen} 2081c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen/* 2091c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * End NFC NCI HAL 2101c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen */ 2111c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 2121c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen/* 2131c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * This is a limited NFC HAL for NXP PN544-based devices. 2141c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * This HAL as Android is moving to 2151c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * an NCI-based NFC stack. 2161c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * 2171c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * All NCI-based NFC controllers should use the NFC-NCI 2181c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen * HAL instead. 21944ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * Begin PN544 specific HAL 22044ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen */ 2211c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen#define NFC_HARDWARE_MODULE_ID "nfc" 2221c970f1a493371aaa68f9227a8c3c395c5112facMartijn Coenen 22344ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen#define NFC_PN544_CONTROLLER "pn544" 22444ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 22544ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenentypedef struct nfc_module_t { 22684d35492b145cebc000f8fd72818eb25b8e65c04Stewart Miles /** 22784d35492b145cebc000f8fd72818eb25b8e65c04Stewart Miles * Common methods of the NFC NXP PN544 module. This *must* be the first member of 22884d35492b145cebc000f8fd72818eb25b8e65c04Stewart Miles * nfc_module_t as users of this structure will cast a hw_module_t to 229b253bcc44a987b81e427e08a722b3daad5990726Stewart Miles * nfc_module_t pointer in contexts where it's known the hw_module_t references a 23084d35492b145cebc000f8fd72818eb25b8e65c04Stewart Miles * nfc_module_t. 23184d35492b145cebc000f8fd72818eb25b8e65c04Stewart Miles */ 23244ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen struct hw_module_t common; 23344ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen} nfc_module_t; 23444ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 23544ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen/* 23644ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * PN544 linktypes. 23744ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * UART 23844ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * I2C 23944ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * USB (uses UART DAL) 24044ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen */ 24144ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenentypedef enum { 24244ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen PN544_LINK_TYPE_UART, 24344ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen PN544_LINK_TYPE_I2C, 24444ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen PN544_LINK_TYPE_USB, 24544ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen PN544_LINK_TYPE_INVALID, 24644ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen} nfc_pn544_linktype; 24744ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 24844ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenentypedef struct { 24984d35492b145cebc000f8fd72818eb25b8e65c04Stewart Miles /** 25084d35492b145cebc000f8fd72818eb25b8e65c04Stewart Miles * Common methods of the NFC NXP PN544 device. This *must* be the first member of 25184d35492b145cebc000f8fd72818eb25b8e65c04Stewart Miles * nfc_pn544_device_t as users of this structure will cast a hw_device_t to 252b253bcc44a987b81e427e08a722b3daad5990726Stewart Miles * nfc_pn544_device_t pointer in contexts where it's known the hw_device_t references a 25384d35492b145cebc000f8fd72818eb25b8e65c04Stewart Miles * nfc_pn544_device_t. 25484d35492b145cebc000f8fd72818eb25b8e65c04Stewart Miles */ 25544ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen struct hw_device_t common; 25644ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 25744ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen /* The number of EEPROM registers to write */ 25844ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen uint32_t num_eeprom_settings; 25944ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 26044ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen /* The actual EEPROM settings 26144ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * For PN544, each EEPROM setting is a 4-byte entry, 26244ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * of the format [0x00, addr_msb, addr_lsb, value]. 26344ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen */ 26444ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen uint8_t* eeprom_settings; 26544ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 26644ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen /* The link type to which the PN544 is connected */ 26744ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen nfc_pn544_linktype linktype; 26844ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 26944ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen /* The device node to which the PN544 is connected */ 27044ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen const char* device_node; 27144ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 27244ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen /* On Crespo we had an I2C issue that would cause us to sometimes read 27344ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * the I2C slave address (0x57) over the bus. libnfc contains 27444ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * a hack to ignore this byte and try to read the length byte 27544ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * again. 27644ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * Set to 0 to disable the workaround, 1 to enable it. 27744ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen */ 27844ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen uint8_t enable_i2c_workaround; 2794cbd62c2ca1600dcd2001d1c5a736abc043a0333Rakesh Goyal /* I2C slave address. Multiple I2C addresses are 2804cbd62c2ca1600dcd2001d1c5a736abc043a0333Rakesh Goyal * possible for PN544 module. Configure address according to 2814cbd62c2ca1600dcd2001d1c5a736abc043a0333Rakesh Goyal * board design. 2824cbd62c2ca1600dcd2001d1c5a736abc043a0333Rakesh Goyal */ 2834cbd62c2ca1600dcd2001d1c5a736abc043a0333Rakesh Goyal uint8_t i2c_device_address; 28444ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen} nfc_pn544_device_t; 28544ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 28644ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenenstatic inline int nfc_pn544_open(const struct hw_module_t* module, 28744ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen nfc_pn544_device_t** dev) { 28844ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen return module->methods->open(module, NFC_PN544_CONTROLLER, 28944ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen (struct hw_device_t**) dev); 29044ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen} 29144ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 29244ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenenstatic inline int nfc_pn544_close(nfc_pn544_device_t* dev) { 29344ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen return dev->common.close(&dev->common); 29444ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen} 29544ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen/* 29644ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen * End PN544 specific HAL 29744ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen */ 29844ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 29944ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen__END_DECLS 30044ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen 30144ae5b24766f8ce4b6b5de01f1deb296d99efd57Martijn Coenen#endif // ANDROID_NFC_HAL_INTERFACE_H 302