MT2523 API Reference LinkIt SDK v4
MediaTek LinkIt™ Development Platform for RTOS provides a comprehensive software solution for devices based on the MediaTek MT2523x SOC, including the LinkIt™ 2523 hardware development kit (HDK). The platform supports hardware abstraction layers, peripheral drivers, FreeRTOS, Bluetooth / Bluetooth Low Energy (BT/BLE), Sensor subsystem and GNSS. This API reference describes the features of and how to use the APIs for each of the supported modules. Each module has a readme.txt under the module root directory. It contains the information about the module dependency, feature options, notes and brief introduction. Please refer to the readme.txt to learn the basic usage of the module.
LinkIt™ SDK for RTOS consists of several software modules, as shown below:
The architecture layers are described below.
The SDK supports the following features when used with the LinkIt 2523 HDK or devices based on the MT2523x:
Bluetooth/Bluetooth Low Energy
Bluetooth/Bluetooth Low Energy contains two modules: Basic Rate / Enhanced Data Rate (BR/EDR) and Bluetooth Low Energy, released as a single library.
BR/EDR module includes the following profiles: GAP, SPP, Hands Free Profile (HFP), Advanced Audio Distribution Profile (A2DP), Audio Video Remote Control Profile (AVRCP) and Phone Book Access Profile (PBAP).
Bluetooth Low Energy module includes the following profiles: GAP, GATT and Security Manager (SM).
The folder structure of the LinkIt SDK is shown below:
The details of the folder contents:
|FOTA||Firmware Over-The-Air (FOTA) is a Mobile Software Management technology in which the operating firmware of a mobile device is wirelessly upgraded and updated by its manufacturer. Please refer to FOTA in Techopedia.|
|GNSS||Global navigation satellite system is a satellite navigation system with global coverage, such as GPS. .|
|HAL||Hardware Abstraction Layer, to guarantee the uniform SDK API for the different hardware and the different chips.|
|A2DP||Advanced Audio Distribution Profile (A2DP). This profile defines how multimedia audio can be streamed from one device to another over a Bluetooth connection (it is also called Bluetooth Audio Streaming), please refer to A2DP in Wikipedia.|
|AVRCP||Audio/Video Remote Control Profile (AVRCP). This profile is designed to provide a standard interface to control TVs, Hi-fi equipment, etc. to allow a single remote control (or other device) to control all of the A/V equipment to which a user has access to. It may be used in concert with A2DP or VDP. It is commonly used in car navigation systems to control streaming Bluetooth audio. Please refer to AVRCP in Wkipedia.|
|HFP||Hands-Free Profile (HFP). This is commonly used to allow car hands-free kits to communicate with mobile phones in the car. It commonly uses Synchronous Connection Oriented link (SCO) to carry a monaural audio channel with continuously variable slope delta modulation or pulse-code modulation, and with logarithmic a-law or ŠÌ-law quantization. Please refer to HFP in WikiPedia.|
|PBAP||Phone Book Access Profile (PBAP). This is a profile that allows exchange of Phone Book Objects between devices. It is likely to be used between a car kit and a mobile phone to allow the car kit to display the name of the incoming caller or allow the car kit to download the phone book so the user can initiate a call from the car display. Please refer to PBAP in Wikipedia.|
|GAP||Generic Access Profile (GAP), provides the basis for all other profiles. GAP defines how two Bluetooth units discover and establish a connection with each other. Please refer to GAP in Wikipedia.|
|SPP||Serial Port Profile (SPP). This profile is based on ETSI 07.10 and the RFCOMM protocol. It emulates a serial cable to provide a simple substitute for existing RS-232, including the familiar control signals. Please refer to SPP in Wikipedia.|
|GATT||Generic Attribute Profile (GATT), provides profile discovery and description services for Bluetooth Low Energy protocol. It defines how ATT attributes are grouped together into sets to form services. Please refer to GATT in Wikipedia.|
|SM||The SMP (Security Manager Protocol) defines the procedures for pairing, authentication, and encryption between LE devices. Please refer to SM introduction in artechhouse.|
(C) 2005-2016 MediaTek Inc. All rights reserved.
This software/firmware and related documentation ("MediaTek Software") are protected under relevant copyright laws. The information contained herein is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors. Without the prior written permission of MediaTek and/or its licensors, any reproduction, modification, use or disclosure of MediaTek Software, and information contained herein, in whole or in part, shall be strictly prohibited. You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software if you have agreed to and been bound by the applicable license agreement with MediaTek ("License Agreement") and been granted explicit permission to do so within the License Agreement ("Permitted User"). If you are not a Permitted User, please cease any access or use of MediaTek Software immediately. BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT. NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE, AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE, OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.