Skip to content

Commit 653ab6a

Browse files
author
Donatien Garnier
committed
Added revision history & table of contents according to #7561
1 parent a989c15 commit 653ab6a

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

docs/design-documents/nfc/nfc_design.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,60 @@
1+
# Near-Field Communication in Mbed OS
2+
3+
## Table of Contents
4+
5+
- [Near-Field Communication in Mbed OS](#near-field-communication-in-mbed-os)
6+
- [Table of Contents](#table-of-contents)
7+
- [Revision history](#revision-history)
8+
- [Introduction](#introduction)
9+
- [Overview and Background](#overview-and-background)
10+
- [Use cases](#use-cases)
11+
- [Commissioning](#commissioning)
12+
- [Identification](#identification)
13+
- [Transport](#transport)
14+
- [BLE Pairing](#ble-pairing)
15+
- [System Architecture and High-Level Design](#system-architecture-and-high-level-design)
16+
- [Compliance with NFC Forum Specifications](#compliance-with-nfc-forum-specifications)
17+
- [User-facing API](#user-facing-api)
18+
- [Phase 1: MicroNFC stack integration](#phase-1-micronfc-stack-integration)
19+
- [Phase 2: NFC Host/Controller split, NCI and NFC HAL API](#phase-2-nfc-hostcontroller-split-nci-and-nfc-hal-api)
20+
- [Detailed Design](#detailed-design)
21+
- [User-facing APIs](#user-facing-apis)
22+
- [NFC Controller](#nfc-controller)
23+
- [Endpoints](#endpoints)
24+
- [NFC Remote Endpoint](#nfc-remote-endpoint)
25+
- [NFC NDEF Capable](#nfc-ndef-capable)
26+
- [NFC Remote Initiator](#nfc-remote-initiator)
27+
- [NFC Target](#nfc-target)
28+
- [NFC EEPROM](#nfc-eeprom)
29+
- [NFC Remote Target](#nfc-remote-target)
30+
- [NDEF API](#ndef-api)
31+
- [Common objects](#common-objects)
32+
- [Parsing](#parsing)
33+
- [ndef::MessageParser](#ndefmessageparser)
34+
- [ndef::MessageParser::Delegate](#ndefmessageparserdelegate)
35+
- [NDEF Record parsing](#ndef-record-parsing)
36+
- [ndef::RecordParser](#ndefrecordparser)
37+
- [ndef::RecordParserChain](#ndefrecordparserchain)
38+
- [ndef::GenericRecordParser<ParserImplementation, ParsingResult>](#ndefgenericrecordparserparserimplementation-parsingresult)
39+
- [ndef::GenericRecordParser<ParserImplementation, ParsingResult>::Delegate](#ndefgenericrecordparserparserimplementation-parsingresultdelegate)
40+
- [Common parsers](#common-parsers)
41+
- [Simple parser](#simple-parser)
42+
- [Delegate](#delegate)
43+
- [Serialization](#serialization)
44+
- [HAL APIs](#hal-apis)
45+
- [NFC EEPROM API](#nfc-eeprom-api)
46+
- [NCI Driver APIs](#nci-driver-apis)
47+
- [Testing strategy](#testing-strategy)
48+
- [NFC Forum Compliance](#nfc-forum-compliance)
49+
- [Interoperability](#interoperability)
50+
- [HAL testing](#hal-testing)
51+
- [Dependencies](#dependencies)
52+
53+
## Revision history
54+
| Revision | Date | Authors | Mbed OS Version | Comments |
55+
|---------- |---------------- |-------------------------------------------------------- |----------------- |------------------ |
56+
| 1.0 | 24 August 2018 | Donatien Garnier (@donatieng); Vincent Coubard (@pan-) | 5.10+ | Initial revision |
57+
158
# Introduction
259
## Overview and Background
360
NFC offers a simple and secure way of commissioning IoT devices in the field, and we are seeing increasing demand for this from prospective customers. We have a plan to introduce NFC into Mbed OS, this is the first phase to add a reference implementation of card emulation mode.

0 commit comments

Comments
 (0)