ucs2-lib/_cfg/ucs_cfg.h

   1 /*------------------------------------------------------------------------------------------------*/
   2 /* UNICENS V2.1.0-3491                                                                            */
   3 /* Copyright (c) 2017 Microchip Technology Germany II GmbH & Co. KG.                              */
   4 /*                                                                                                */
   5 /* This program is free software: you can redistribute it and/or modify                           */
   6 /* it under the terms of the GNU General Public License as published by                           */
   7 /* the Free Software Foundation, either version 2 of the License, or                              */
   8 /* (at your option) any later version.                                                            */
   9 /*                                                                                                */
  10 /* This program is distributed in the hope that it will be useful,                                */
  11 /* but WITHOUT ANY WARRANTY; without even the implied warranty of                                 */
  12 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                                  */
  13 /* GNU General Public License for more details.                                                   */
  14 /*                                                                                                */
  15 /* You should have received a copy of the GNU General Public License                              */
  16 /* along with this program.  If not, see <http://www.gnu.org/licenses/>.                          */
  17 /*                                                                                                */
  18 /* You may also obtain this software under a propriety license from Microchip.                    */
  19 /* Please contact Microchip for further information.                                              */
  20 /*------------------------------------------------------------------------------------------------*/
  21
  22 #ifndef UCS_CFG_H
  23 #define UCS_CFG_H
  24
  25 #ifdef __cplusplus
  26 extern "C"
  27 {
  28 #endif
  29
  30 /*------------------------------------------------------------------------------------------------*/
  31 /* Includes                                                                                       */
  32 /*------------------------------------------------------------------------------------------------*/
  33 #include "ucs_types_cfg.h"
  34
  35 /*------------------------------------------------------------------------------------------------*/
  36 /* Multi Instance API                                                                             */
  37 /*------------------------------------------------------------------------------------------------*/
  38 /* Number of API instances which can be created by function Ucs_CreateInstance().
  39  * One API instance is used to communicate with one local INIC. In this case the application
  40  * is connected to one network.
  41  * It is possible access multiple networks by having multiple API instances. Each API instance
  42  * requires communication with an exclusive INIC.
  43  * Valid range: 1..10. Default value: 1.
  44  */
  45 /* #define UCS_NUM_INSTANCES                1 */
  46
  47 /*------------------------------------------------------------------------------------------------*/
  48 /* Resources Management                                                                           */
  49 /*------------------------------------------------------------------------------------------------*/
  50 /* Maximum number of remote devices used by Resources Management modules.
  51  * Valid range: 0..63. Default value: 0.
  52  */
  53 /* #define UCS_NUM_REMOTE_DEVICES            0U */
  54
  55 /*------------------------------------------------------------------------------------------------*/
  56 /* Application Messages                                                                           */
  57 /*------------------------------------------------------------------------------------------------*/
  58 /* Defines the number of reserved Rx message objects.
  59  * Valid values: 5..255. Default value: 20.
  60  */
  61 /* #define UCS_AMS_NUM_RX_MSGS              20 */
  62
  63 /* Defines the payload size in bytes which is available for every Rx message object.
  64  * Valid values: 45..65535. Default value: 45.
  65  */
  66 /* #define UCS_AMS_SIZE_RX_MSG              45 */
  67
  68 /* Defines the number of reserved Tx message objects.
  69  * Valid values: 5..255. Default value: 20.
  70  */
  71 /* #define UCS_AMS_NUM_TX_MSGS              20 */
  72
  73 /* Defines the payload size in bytes which is available for every Tx message object.
  74  * Valid values: 45..65535. Default value: 45.
  75  */
  76 /* #define UCS_AMS_SIZE_TX_MSG              45 */
  77
  78 /*------------------------------------------------------------------------------------------------*/
  79 /* Memory Optimization                                                                            */
  80 /*------------------------------------------------------------------------------------------------*/
  81 /* Define the following macros to reduces the RAM and ROM size of the UNICENS software by disabling
  82  * certain features. If this macro is defined the following changes apply:
  83  * - Reduction of low-level buffers
  84  * - AMS does not support segmentation (payload > 45 bytes)
  85  */
  86 /* #define UCS_FOOTPRINT_TINY */
  87
  88 /*------------------------------------------------------------------------------------------------*/
  89 /* Tracing & Debugging                                                                            */
  90 /*------------------------------------------------------------------------------------------------*/
  91 /* Define the following macros to map info and error trace output to user defined functions.
  92  * The purpose of these functions is debugging. It is not recommended to define these functions
  93  * in a production system.
  94  */
  95 /* #define UCS_TR_ERROR     App_TraceError */
  96 /* #define UCS_TR_INFO      App_TraceInfo */
  97
  98 /* extern void App_TraceError(void *ucs_user_ptr, const char module_str[], const char entry_str[], uint16_t vargs_cnt, ...); */
  99 /* extern void App_TraceInfo(void *ucs_user_ptr, const char module_str[], const char entry_str[], uint16_t vargs_cnt, ...); */
 100
 101 #ifdef __cplusplus
 102 }
 103 #endif
 104
 105 #endif /* UCS_CFG_H */
 106
 107 /*------------------------------------------------------------------------------------------------*/
 108 /* End of file                                                                                    */
 109 /*------------------------------------------------------------------------------------------------*/
 110