mirror of https://github.com/ARMmbed/mbed-os.git
105 lines
2.7 KiB
C++
105 lines
2.7 KiB
C++
/* mbed Microcontroller Library
|
|
* Copyright (c) 2018 ARM Limited
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef MBED_NFC_CONTROLLER_DRIVER_H
|
|
#define MBED_NFC_CONTROLLER_DRIVER_H
|
|
|
|
#include <stdint.h>
|
|
#include "events/EventQueue.h"
|
|
|
|
#include "stack/nfc_errors.h"
|
|
#include "stack/transceiver/transceiver.h"
|
|
#include "stack/platform/nfc_scheduler.h"
|
|
|
|
namespace mbed {
|
|
namespace nfc {
|
|
|
|
/**
|
|
* @addtogroup nfc
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* The abstraction for a NFC controller driver.
|
|
* Implementers need to derive from this class and implement its methods.
|
|
*/
|
|
class NFCControllerDriver {
|
|
public:
|
|
/**
|
|
* Instantiate a NFCControllerDriver
|
|
*/
|
|
NFCControllerDriver();
|
|
|
|
/**
|
|
* NFCControllerDriver destructor
|
|
*/
|
|
virtual ~NFCControllerDriver();
|
|
|
|
/**
|
|
* The NFCControllerDriver delegate
|
|
*/
|
|
struct Delegate {
|
|
/**
|
|
* Called when the controller asserts the interrupt line
|
|
*/
|
|
virtual void on_hw_interrupt() {}
|
|
|
|
protected:
|
|
~Delegate() {}
|
|
};
|
|
|
|
/**
|
|
* Initialize the driver and retrieve the interface to the controller.
|
|
*
|
|
* @param[in] scheduler_timer a timer to initialize the controller's scheduler instance with
|
|
* @return an initialized MicroNFC nfc_transceiver_t instance
|
|
*/
|
|
virtual nfc_transceiver_t *initialize(nfc_scheduler_timer_t *scheduler_timer) = 0;
|
|
|
|
/**
|
|
* Retrieve list of technologies supported by the controller
|
|
* @param[out] initiator bitmask of technologies supported when the controller is in initiator mode
|
|
* @param[out] target bitmask of technologies supported when the controller is in target mode
|
|
*/
|
|
virtual void get_supported_nfc_techs(nfc_tech_t *initiator, nfc_tech_t *target) const = 0;
|
|
|
|
/**
|
|
* Set this instance's delegate
|
|
*
|
|
* @param[in] delegate the delegate instance to use
|
|
*/
|
|
void set_delegate(Delegate *delegate);
|
|
|
|
protected:
|
|
/**
|
|
* An implementation must call this function (can be called from interrupt context)
|
|
* when the controller asserts its interrupt line
|
|
*/
|
|
void hw_interrupt();
|
|
|
|
private:
|
|
Delegate *_delegate;
|
|
};
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
} // namespace nfc
|
|
} // namespace mbed
|
|
|
|
#endif
|