device_manager_cnfg.h

00001 /*
00002  * Copyright (c) Nordic Semiconductor ASA
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without modification,
00006  * are permitted provided that the following conditions are met:
00007  *
00008  *   1. Redistributions of source code must retain the above copyright notice, this
00009  *   list of conditions and the following disclaimer.
00010  *
00011  *   2. Redistributions in binary form must reproduce the above copyright notice, this
00012  *   list of conditions and the following disclaimer in the documentation and/or
00013  *   other materials provided with the distribution.
00014  *
00015  *   3. Neither the name of Nordic Semiconductor ASA nor the names of other
00016  *   contributors to this software may be used to endorse or promote products
00017  *   derived from this software without specific prior written permission.
00018  *
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
00021  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00022  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00023  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
00024  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00025  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00026  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
00027  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00028  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00029  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00030  *
00031  */
00032 
00033  /**
00034  * @file device_manager_cnfg.h
00035  *
00036  * @cond
00037  * @defgroup device_manager_cnfg Device Manager Configuration 
00038  * @ingroup device_manager
00039  * @{
00040  *
00041  * @brief Defines application specific configuration for Device Manager.
00042  *
00043  * @details All configurations that are specific to application have been defined
00044  *          here. Application should configuration that best suits its requirements.
00045  */
00046  
00047 #ifndef DEVICE_MANAGER_CNFG_H__
00048 #define DEVICE_MANAGER_CNFG_H__
00049 
00050 /**
00051  * @defgroup device_manager_inst Device Manager Instances
00052  * @{
00053  */
00054 /**
00055  * @brief Maximum applications that Device Manager can support.
00056  *
00057  * @details Maximum application that the Device Manager can support.
00058  *          Currently only one application can be supported.
00059  *          Minimum value : 1
00060  *          Maximum value : 1
00061  *          Dependencies  : None.
00062  */
00063 #define DEVICE_MANAGER_MAX_APPLICATIONS  1
00064 
00065 /**
00066  * @brief Maximum connections that Device Manager should simultaneously manage.
00067  *
00068  * @details Maximum connections that Device Manager should simultaneously manage.
00069  *          Minimum value : 1
00070  *          Maximum value : Maximum links supported by SoftDevice.
00071  *          Dependencies  : None.
00072  */
00073 #define DEVICE_MANAGER_MAX_CONNECTIONS   1
00074 
00075 
00076 /**
00077  * @brief Maximum bonds that Device Manager should manage.
00078  *
00079  * @details Maximum bonds that Device Manager should manage.
00080  *          Minimum value : 1
00081  *          Maximum value : 254.
00082  *          Dependencies  : None.
00083  * @note In case of GAP Peripheral role, the Device Manager will accept bonding procedure 
00084  *       requests from peers even if this limit is reached, but bonding information will not 
00085  *       be stored. In such cases, application will be notified with DM_DEVICE_CONTEXT_FULL 
00086  *       as event result at the completion of the security procedure.
00087  */
00088 #define DEVICE_MANAGER_MAX_BONDS         2
00089 
00090 
00091 /**
00092  * @brief Maximum Characteristic Client Descriptors used for GATT Server.
00093  *
00094  * @details Maximum Characteristic Client Descriptors used for GATT Server.
00095  *          Minimum value : 1
00096  *          Maximum value : 254.
00097  *          Dependencies  : None.
00098  */
00099 #define DM_GATT_CCCD_COUNT               2
00100 
00101 
00102 /**
00103  * @brief Size of application context.
00104  *
00105  * @details Size of application context that Device Manager should manage for each bonded device.
00106  *          Size had to be a multiple of word size.
00107  *          Minimum value : 4.
00108  *          Maximum value : 256. 
00109  *          Dependencies  : Needed only if Application Context saving is used by the application.
00110  * @note If set to zero, its an indication that application context is not required to be managed
00111  *       by the module.
00112  */
00113 #define DEVICE_MANAGER_APP_CONTEXT_SIZE    0
00114 
00115 /* @} */
00116 /* @} */
00117 /** @endcond */
00118 #endif // DEVICE_MANAGER_CNFG_H__
00119