FreeRTOS: FreeRTOS Cellular Library v1.2.0
FreeRTOS Cellular Library
cellular_config_defaults.h
Go to the documentation of this file.
1/*
2 * FreeRTOS-Cellular-Interface v1.2.0
3 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9 * the Software, and to permit persons to whom the Software is furnished to do so,
10 * subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 *
22 * https://www.FreeRTOS.org
23 * https://github.com/FreeRTOS
24 */
25
38#ifndef __CELLULAR_CONFIG_DEFAULTS_H__
39#define __CELLULAR_CONFIG_DEFAULTS_H__
40
41/* *INDENT-OFF* */
42#ifdef __cplusplus
43 extern "C" {
44#endif
45/* *INDENT-ON* */
46
47/* The macro definition for CELLULAR_DO_NOT_USE_CUSTOM_CONFIG is for Doxygen
48 * documentation only. */
49
60#ifdef DOXYGEN
61 #define CELLULAR_DO_NOT_USE_CUSTOM_CONFIG
62#endif
63
70#ifndef CELLULAR_MCC_MAX_SIZE
71 #define CELLULAR_MCC_MAX_SIZE ( 3U )
72#endif
73
80#ifndef CELLULAR_MNC_MAX_SIZE
81 #define CELLULAR_MNC_MAX_SIZE ( 3U )
82#endif
83
90#ifndef CELLULAR_ICCID_MAX_SIZE
91 #define CELLULAR_ICCID_MAX_SIZE ( 20U )
92#endif
93
100#ifndef CELLULAR_IMSI_MAX_SIZE
101 #define CELLULAR_IMSI_MAX_SIZE ( 15U )
102#endif
103
110#ifndef CELLULAR_FW_VERSION_MAX_SIZE
111 #define CELLULAR_FW_VERSION_MAX_SIZE ( 32U )
112#endif
113
120#ifndef CELLULAR_HW_VERSION_MAX_SIZE
121 #define CELLULAR_HW_VERSION_MAX_SIZE ( 12U )
122#endif
123
130#ifndef CELLULAR_SERIAL_NUM_MAX_SIZE
131 #define CELLULAR_SERIAL_NUM_MAX_SIZE ( 12U )
132#endif
133
140#ifndef CELLULAR_IMEI_MAX_SIZE
141 #define CELLULAR_IMEI_MAX_SIZE ( 15U )
142#endif
143
150#ifndef CELLULAR_NETWORK_NAME_MAX_SIZE
151 #define CELLULAR_NETWORK_NAME_MAX_SIZE ( 32U )
152#endif
153
160#ifndef CELLULAR_APN_MAX_SIZE
161 #define CELLULAR_APN_MAX_SIZE ( 64U )
162#endif
163
170#ifndef CELLULAR_PDN_USERNAME_MAX_SIZE
171 #define CELLULAR_PDN_USERNAME_MAX_SIZE ( 32U )
172#endif
173
180#ifndef CELLULAR_PDN_PASSWORD_MAX_SIZE
181 #define CELLULAR_PDN_PASSWORD_MAX_SIZE ( 32u )
182#endif
183
190#ifndef CELLULAR_IP_ADDRESS_MAX_SIZE
191 #define CELLULAR_IP_ADDRESS_MAX_SIZE ( 40U )
192#endif
193
200#ifndef CELLULAR_AT_CMD_MAX_SIZE
201 #define CELLULAR_AT_CMD_MAX_SIZE ( 200U )
202#endif
203
210#ifndef CELLULAR_NUM_SOCKET_MAX
211 #define CELLULAR_NUM_SOCKET_MAX ( 12U )
212#endif
213
220#ifndef CELLULAR_MANUFACTURE_ID_MAX_SIZE
221 #define CELLULAR_MANUFACTURE_ID_MAX_SIZE ( 20U )
222#endif
223
230#ifndef CELLULAR_MODEL_ID_MAX_SIZE
231 #define CELLULAR_MODEL_ID_MAX_SIZE ( 10U )
232#endif
233
240#ifndef CELLULAR_EDRX_LIST_MAX_SIZE
241 #define CELLULAR_EDRX_LIST_MAX_SIZE ( 4U )
242#endif
243
250#ifndef CELLULAR_PDN_CONTEXT_ID_MIN
251 #define CELLULAR_PDN_CONTEXT_ID_MIN ( 1U )
252#endif
253
260#ifndef CELLULAR_PDN_CONTEXT_ID_MAX
261 #define CELLULAR_PDN_CONTEXT_ID_MAX ( 16U )
262#endif
263
270#ifndef CELLULAR_MAX_RAT_PRIORITY_COUNT
271 #define CELLULAR_MAX_RAT_PRIORITY_COUNT ( 3U )
272#endif
273
280#ifndef CELLULAR_MAX_SEND_DATA_LEN
281 #define CELLULAR_MAX_SEND_DATA_LEN ( 1460U )
282#endif
283
290#ifndef CELLULAR_MAX_RECV_DATA_LEN
291 #define CELLULAR_MAX_RECV_DATA_LEN ( 1500U )
292#endif
293
300#ifndef CELLULAR_SUPPORT_GETHOSTBYNAME
301 #define CELLULAR_SUPPORT_GETHOSTBYNAME ( 1U )
302#endif
303
310#ifndef CELLULAR_COMM_IF_SEND_TIMEOUT_MS
311 #define CELLULAR_COMM_IF_SEND_TIMEOUT_MS ( 1000U )
312#endif
313
320#ifndef CELLULAR_COMM_IF_RECV_TIMEOUT_MS
321 #define CELLULAR_COMM_IF_RECV_TIMEOUT_MS ( 1000U )
322#endif
323
330#ifndef CELLULAR_CONFIG_STATIC_ALLOCATION_CONTEXT
331 #define CELLULAR_CONFIG_STATIC_ALLOCATION_CONTEXT ( 0U )
332#endif
333
340#ifndef CELLULAR_CONFIG_STATIC_COMM_CONTEXT_ALLOCATION
341 #define CELLULAR_CONFIG_STATIC_COMM_CONTEXT_ALLOCATION ( 0U )
342#endif
343
350#ifndef CELLULAR_CONFIG_DEFAULT_RAT
351 #define CELLULAR_CONFIG_DEFAULT_RAT ( 8 ) /* Set default RAT to CELLULAR_RAT_CATM1 @ref CellularRat_t. */
352#endif
353
360#ifndef CELLULAR_CONFIG_STATIC_SOCKET_CONTEXT_ALLOCATION
361 #define CELLULAR_CONFIG_STATIC_SOCKET_CONTEXT_ALLOCATION ( 0 )
362#endif
363
378#ifndef LogError
379 #define LogError( message )
380#endif
381
396#ifndef LogWarn
397 #define LogWarn( message )
398#endif
399
414#ifndef LogInfo
415 #define LogInfo( message )
416#endif
417
432#ifndef LogDebug
433 #define LogDebug( message )
434#endif
435
436/* *INDENT-OFF* */
437#ifdef __cplusplus
438 }
439#endif
440/* *INDENT-ON* */
441
442#endif /* __CELLULAR_CONFIG_DEFAULTS_H__ */