user.h 30.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
/*
 * user.h - CC31xx/CC32xx Host Driver Implementation
 *
 * Copyright (C) 2015 Texas Instruments Incorporated - http://www.ti.com/
 *
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 *  Adapted for PIC32 by 2016 Cesanta Software Limited
 */

#ifndef __USER_H__
#define __USER_H__

#ifdef __cplusplus
extern "C" {
#endif

/*!
 ******************************************************************************

    \defgroup       porting_user_include        Porting - User Include Files

    This section IS NOT REQUIRED in case user provided primitives are handled
    in makefiles or project configurations (IDE)

    PORTING ACTION:
        - Include all required header files for the definition of:
            -# Transport layer library API (e.g. SPI, UART)
            -# OS primitives definitions (e.g. Task spawn, Semaphores)
            -# Memory management primitives (e.g. alloc, free)

 ******************************************************************************
 */
#undef FD_SETSIZE
#undef FD_SET
#undef FD_CLR
#undef FD_ISSET
#undef FD_ZERO
#undef htonl
#undef ntohl
#undef htons
#undef ntohs
#undef EBADF
#undef ENOMEM
#undef EINVAL
#include <string.h>

typedef int Fd_t;

typedef void (*P_EVENT_HANDLER)(void *pValue);

typedef P_EVENT_HANDLER SL_P_EVENT_HANDLER;

/*!
    \def        MAX_CONCURRENT_ACTIONS

    \brief      Defines the maximum number of concurrent action in the system
                Min:1 , Max: 32

                Actions which has async events as return, can be

    \sa

    \note       In case there are not enough resources for the actions needed
                in the system, error is received: POOL_IS_EMPTY one option is
                to increase MAX_CONCURRENT_ACTIONS (improves performance but
                results in memory consumption) Other option is to call the API
                later (decrease performance)

    \warning    In case of setting to one, recommend to use non-blocking
                recv\recvfrom to allow multiple socket recv
*/
#define MAX_CONCURRENT_ACTIONS 10

/*!
 ******************************************************************************

    \defgroup       proting_capabilities        Porting - Capabilities Set

    This section IS NOT REQUIRED in case one of the following pre defined
    capabilities set is in use:
    - SL_TINY
    - SL_SMALL
    - SL_FULL

    PORTING ACTION:
        - Define one of the pre-defined capabilities set or uncomment the
          relevant definitions below to select the required capabilities

    @{

 *******************************************************************************
*/

/*!
    \def        SL_INC_ARG_CHECK

    \brief      Defines whether the SimpleLink driver perform argument check
                or not

                When defined, the SimpleLink driver perform argument check on
                function call. Removing this define could reduce some code
                size and improve slightly the performances but may impact in
                unpredictable behavior in case of invalid arguments

    \sa

    \note       belongs to \ref proting_sec

    \warning    Removing argument check may cause unpredictable behavior in
                case of invalid arguments.
                In this case the user is responsible to argument validity
                (for example all handlers must not be NULL)
*/
#define SL_INC_ARG_CHECK

/*!
    \def        SL_INC_STD_BSD_API_NAMING

    \brief      Defines whether SimpleLink driver should expose standard BSD
                APIs or not

                When defined, the SimpleLink driver in addtion to its
   alternative
                BSD APIs expose also standard BSD APIs.
    Stadrad BSD API includs the following functions:
                socket , close , accept , bind , listen , connect , select ,
                setsockopt  , getsockopt , recv , recvfrom , write , send ,
   sendto ,
                gethostbyname

    \sa

    \note       belongs to \ref proting_sec

    \warning
*/

#define SL_INC_STD_BSD_API_NAMING

/*!
    \brief      Defines whether to include extended API in SimpleLink driver
                or not

                When defined, the SimpleLink driver will include also all
                exteded API of the included packages

    \sa             ext_api

    \note       belongs to \ref proting_sec

    \warning
*/
#define SL_INC_EXT_API

/*!
    \brief      Defines whether to include WLAN package in SimpleLink driver
                or not

                When defined, the SimpleLink driver will include also
                the WLAN package

    \sa

    \note       belongs to \ref proting_sec

    \warning
*/
#define SL_INC_WLAN_PKG

/*!
    \brief      Defines whether to include SOCKET package in SimpleLink
                driver or not

                When defined, the SimpleLink driver will include also
                the SOCKET package

    \sa

    \note       belongs to \ref proting_sec

    \warning
*/
#define SL_INC_SOCKET_PKG

/*!
    \brief      Defines whether to include NET_APP package in SimpleLink
                driver or not

                When defined, the SimpleLink driver will include also the
                NET_APP package

    \sa

    \note       belongs to \ref proting_sec

    \warning
*/
#define SL_INC_NET_APP_PKG

/*!
    \brief      Defines whether to include NET_CFG package in SimpleLink
                driver or not

                When defined, the SimpleLink driver will include also
                the NET_CFG package

    \sa

    \note       belongs to \ref proting_sec

    \warning
*/
#define SL_INC_NET_CFG_PKG

/*!
    \brief      Defines whether to include NVMEM package in SimpleLink
                driver or not

                When defined, the SimpleLink driver will include also the
                NVMEM package

    \sa

    \note       belongs to \ref proting_sec

    \warning
*/
#define SL_INC_NVMEM_PKG

/*!
    \brief      Defines whether to include socket server side APIs
                in SimpleLink driver or not

                When defined, the SimpleLink driver will include also socket
                server side APIs

    \sa             server_side

    \note

    \warning
*/
#define SL_INC_SOCK_SERVER_SIDE_API

/*!
    \brief      Defines whether to include socket client side APIs in SimpleLink
                driver or not

                When defined, the SimpleLink driver will include also socket
                client side APIs

    \sa             client_side

    \note       belongs to \ref proting_sec

    \warning
*/
#define SL_INC_SOCK_CLIENT_SIDE_API

/*!
    \brief      Defines whether to include socket receive APIs in SimpleLink
                driver or not

                When defined, the SimpleLink driver will include also socket
                receive side APIs

    \sa             recv_api

    \note       belongs to \ref proting_sec

    \warning
*/
#define SL_INC_SOCK_RECV_API

/*!
    \brief      Defines whether to include socket send APIs in SimpleLink
                driver or not

                When defined, the SimpleLink driver will include also socket
                send side APIs

    \sa             send_api

    \note       belongs to \ref proting_sec

    \warning
*/
#define SL_INC_SOCK_SEND_API

/*!

 Close the Doxygen group.
 @}

 */

/*!
 ******************************************************************************

    \defgroup   porting_enable_device       Porting - Device Enable/Disable

    The enable/disable line (nHib) provide mechanism to enter the device into
    the least current consumption mode. This mode could be used when no traffic
    is required (tx/rx).
    when this hardware line is not connected to any IO of the host this define
    should be left empty.


    \note   Not connecting this line results in ability to start the driver
            only once.

    PORTING ACTION:
        - Bind the GPIO that is connected to the device to the SimpleLink
          driver

    @{

 ******************************************************************************
*/
/*!
    \brief		Preamble to the enabling the Network Processor.
                        Placeholder to implement any pre-process operations
                        before enabling networking operations.

    \sa			sl_DeviceEnable

    \note       belongs to \ref ported_sec

*/
#define sl_DeviceEnablePreamble()

/*!
    \brief      Enable the device by set the appropriate GPIO to high

    \sa         sl_DeviceDisable

    \note           belongs to \ref proting_sec

    \warning    if nHib/nShutdown pins are not connected to the host this define
                should be left empty. Not connecting on of these lines may
   result
                in higher power consumption and inability to start and stop the
                driver correctly.
*/
#define sl_DeviceEnable CC3100_enable

/*!
    \brief      Disable the device by setting the appropriate GPIO to Low

    \sa         sl_DeviceEnable

    \note           belongs to \ref proting_sec

    \warning    if nHib/nShutdown pins are not connected to the host this define
                should be left empty. Not connecting on of these lines may
   result
                in higher power consumption and inability to start and stop the
                driver correctly.
*/

#define sl_DeviceDisable CC3100_disable

/*!

 Close the Doxygen group.
 @}

 */

/*!
 ******************************************************************************

    \defgroup   porting_interface         Porting - Communication Interface

    The simple link device can work with different communication
    channels (e.g. spi/uart). Texas Instruments provides single driver
    that can work with all these types. This section bind between the
    physical communication interface channel and the SimpleLink driver


    \note       Correct and efficient implementation of this driver is critical
                for the performances of the SimpleLink device on this platform.


    PORTING ACTION:
        - Bind the functions of the communication channel interface driver with
          the simple link driver

    @{

 ******************************************************************************
*/

#define _SlFd_t int

/*!
    \brief      Opens an interface communication port to be used for
   communicating
                with a SimpleLink device

                Given an interface name and option flags, this function opens
                the communication port and creates a file descriptor.
                This file descriptor is used afterwards to read and write
                data from and to this specific communication channel.
                The speed, clock polarity, clock phase, chip select and all
   other
                specific attributes of the channel are all should be set to
   hardcoded
                in this function.

    \param      ifName  -   points to the interface name/path. The interface
   name is an
                            optional attributes that the simple link driver
   receives
                            on opening the driver (sl_Start).
                            In systems that the spi channel is not implemented
   as
                            part of the os device drivers, this parameter could
   be NULL.

    \param      flags   -   optional flags parameters for future use

    \return     upon successful completion, the function shall open the channel
                and return a non-negative integer representing the file
   descriptor.
                Otherwise, -1 shall be returned

    \sa         sl_IfClose , sl_IfRead , sl_IfWrite

    \note       The prototype of the function is as follow:
                    Fd_t xxx_IfOpen(char* pIfName , unsigned long flags);

    \note       belongs to \ref proting_sec

    \warning
*/
#define sl_IfOpen spi_Open

/*!
    \brief      Closes an opened interface communication port

    \param      fd  -   file descriptor of opened communication channel

    \return     upon successful completion, the function shall return 0.
                Otherwise, -1 shall be returned

    \sa         sl_IfOpen , sl_IfRead , sl_IfWrite

    \note       The prototype of the function is as follow:
                    int xxx_IfClose(Fd_t Fd);

    \note       belongs to \ref proting_sec

    \warning
*/
#define sl_IfClose spi_Close

/*!
    \brief      Attempts to read up to len bytes from an opened communication
   channel
                into a buffer starting at pBuff.

    \param      fd      -   file descriptor of an opened communication channel

    \param      pBuff   -   pointer to the first location of a buffer that
   contains enough
                            space for all expected data

    \param      len     -   number of bytes to read from the communication
   channel

    \return     upon successful completion, the function shall return the number
   of read bytes.
                Otherwise, 0 shall be returned

    \sa         sl_IfClose , sl_IfOpen , sl_IfWrite


    \note       The prototype of the function is as follow:
                    int xxx_IfRead(Fd_t Fd , char* pBuff , int Len);

    \note       belongs to \ref proting_sec

    \warning
*/
#define sl_IfRead spi_Read

/*!
    \brief attempts to write up to len bytes to the SPI channel

    \param      fd      -   file descriptor of an opened communication channel

    \param      pBuff   -   pointer to the first location of a buffer that
   contains
                            the data to send over the communication channel

    \param      len     -   number of bytes to write to the communication
   channel

    \return     upon successful completion, the function shall return the number
   of sent bytes.
                therwise, 0 shall be returned

    \sa         sl_IfClose , sl_IfOpen , sl_IfRead

    \note       This function could be implemented as zero copy and return only
   upon successful completion
                of writing the whole buffer, but in cases that memory allocation
   is not too tight, the
                function could copy the data to internal buffer, return back and
   complete the write in
                parallel to other activities as long as the other SPI activities
   would be blocked until
                the entire buffer write would be completed

               The prototype of the function is as follow:
                    int xxx_IfWrite(Fd_t Fd , char* pBuff , int Len);

    \note       belongs to \ref proting_sec

    \warning
*/
#define sl_IfWrite spi_Write

/*!
    \brief      register an interrupt handler routine for the host IRQ

    \param      InterruptHdl    -   pointer to interrupt handler routine

    \param      pValue          -   pointer to a memory structure that is passed
                                    to the interrupt handler.

    \return     upon successful registration, the function shall return 0.
                Otherwise, -1 shall be returned

    \sa

    \note       If there is already registered interrupt handler, the function
                should overwrite the old handler with the new one

    \note       If the handler is a null pointer, the function should
   un-register the
                interrupt handler, and the interrupts can be disabled.

    \note       belongs to \ref proting_sec

    \warning
*/
#define sl_IfRegIntHdlr(InterruptHdl, pValue) \
  registerInterruptHandler(InterruptHdl, pValue)
/*!
    \brief      Masks the Host IRQ

    \sa         sl_IfUnMaskIntHdlr



    \note       belongs to \ref proting_sec

    \warning
*/

#define sl_IfMaskIntHdlr()

/*!
    \brief     Unmasks the Host IRQ

    \sa        sl_IfMaskIntHdlr



    \note      belongs to \ref proting_sec

    \warning
*/

#define sl_IfUnMaskIntHdlr()

/*!
    \brief      Write Handers for statistics debug on write

    \param      interface handler   -   pointer to interrupt handler routine


    \return     no return value

    \sa

    \note       An optional hooks for monitoring before and after write info

    \note       belongs to \ref proting_sec

    \warning
*/
/*
#define SL_START_WRITE_STAT
*/

#ifdef SL_START_WRITE_STAT
#define sl_IfStartWriteSequence SlStudio_SpiStartWriteSeq
#define sl_IfEndWriteSequence SlStudio_SpiEndWriteSeq
#endif
/*!

 Close the Doxygen group.
 @}

*/

/*!
 ******************************************************************************

    \defgroup   porting_mem_mgm             Porting - Memory Management

    This section declare in which memory management model the SimpleLink driver
    will run:
        -# Static
        -# Dynamic

    This section IS NOT REQUIRED in case Static model is selected.

    The default memory model is Static

    PORTING ACTION:
        - If dynamic model is selected, define the alloc and free functions.

    @{

 *****************************************************************************
*/

/*!
    \brief      Defines whether the SimpleLink driver is working in dynamic
                memory model or not

                When defined, the SimpleLink driver use dynamic allocations
                if dynamic allocation is selected malloc and free functions
                must be retrieved

    \sa

    \note       belongs to \ref proting_sec

    \warning
*/

/*
#define SL_MEMORY_MGMT_DYNAMIC
*/

#ifdef SL_MEMORY_MGMT_DYNAMIC

/*!
    \brief

    \sa

    \note           belongs to \ref proting_sec

    \warning
*/
#define sl_Malloc(Size) malloc(Size)

/*!
    \brief

    \sa

    \note           belongs to \ref proting_sec

    \warning
*/
#define sl_Free(pMem) free(pMem)

#endif

/*!

 Close the Doxygen group.
 @}

*/

/*!
 ******************************************************************************

    \defgroup   porting_os          Porting - Operating System

    The simple link driver can run on multi-threaded environment as well
    as non-os environment (mail loop)

    This section IS NOT REQUIRED in case you are working on non-os environment.

    If you choose to work in multi-threaded environment under any operating
 system
    you will have to provide some basic adaptation routines to allow the driver
    to protect access to resources from different threads (locking object) and
    to allow synchronization between threads (sync objects).

    PORTING ACTION:
        -# Uncomment SL_PLATFORM_MULTI_THREADED define
        -# Bind locking object routines
        -# Bind synchronization object routines
        -# Optional - Bind spawn thread routine

    @{

 ******************************************************************************
*/

/*
#define SL_PLATFORM_MULTI_THREADED
*/

#ifdef SL_PLATFORM_MULTI_THREADED

/*!
    \brief
    \sa
    \note           belongs to \ref proting_sec
    \warning
*/
#define SL_OS_RET_CODE_OK

/*!
    \brief
    \sa
    \note           belongs to \ref proting_sec
    \warning
*/
#define SL_OS_WAIT_FOREVER

/*!
    \brief
    \sa
    \note           belongs to \ref proting_sec
    \warning
*/
#define SL_OS_NO_WAIT

/*!
    \brief type definition for a time value

    \note   On each porting or platform the type could be whatever is needed -
   integer, pointer to structure etc.

    \note       belongs to \ref proting_sec
*/
#define _SlTime_t

/*!
    \brief  type definition for a sync object container

    Sync object is object used to synchronize between two threads or thread and
   interrupt handler.
    One thread is waiting on the object and the other thread send a signal,
   which then
    release the waiting thread.
    The signal must be able to be sent from interrupt context.
    This object is generally implemented by binary semaphore or events.

    \note   On each porting or platform the type could be whatever is needed -
   integer, structure etc.

    \note       belongs to \ref proting_sec
*/
#define _SlSyncObj_t

/*!
    \brief  This function creates a sync object

    The sync object is used for synchronization between diffrent thread or ISR
   and
    a thread.

    \param  pSyncObj    -   pointer to the sync object control block

    \return upon successful creation the function should return 0
            Otherwise, a negative value indicating the error code shall be
   returned

    \note       belongs to \ref proting_sec
    \warning
*/
#define sl_SyncObjCreate(pSyncObj, pName)

/*!
    \brief  This function deletes a sync object

    \param  pSyncObj    -   pointer to the sync object control block

    \return upon successful deletion the function should return 0
            Otherwise, a negative value indicating the error code shall be
   returned
    \note       belongs to \ref proting_sec
    \warning
*/
#define sl_SyncObjDelete(pSyncObj)

/*!
    \brief      This function generates a sync signal for the object.

    All suspended threads waiting on this sync object are resumed

    \param      pSyncObj    -   pointer to the sync object control block

    \return     upon successful signaling the function should return 0
                Otherwise, a negative value indicating the error code shall be
   returned
    \note       the function could be called from ISR context
    \warning
*/
#define sl_SyncObjSignal(pSyncObj)

/*!
    \brief  This function waits for a sync signal of the specific sync object

    \param  pSyncObj    -   pointer to the sync object control block
    \param  Timeout     -   numeric value specifies the maximum number of mSec
   to
                            stay suspended while waiting for the sync signal
                            Currently, the simple link driver uses only two
   values:
                                - OSI_WAIT_FOREVER
                                - OSI_NO_WAIT

    \return upon successful reception of the signal within the timeout window
   return 0
            Otherwise, a negative value indicating the error code shall be
   returned
    \note       belongs to \ref proting_sec
    \warning
*/
#define sl_SyncObjWait(pSyncObj, Timeout)

/*!
    \brief  type definition for a locking object container

    Locking object are used to protect a resource from mutual accesses of two or
   more threads.
    The locking object should suppurt reentrant locks by a signal thread.
    This object is generally implemented by mutex semaphore

    \note   On each porting or platform the type could be whatever is needed -
   integer, structure etc.
    \note       belongs to \ref proting_sec
*/
#define _SlLockObj_t

/*!
    \brief  This function creates a locking object.

    The locking object is used for protecting a shared resources between
   different
    threads.

    \param  pLockObj    -   pointer to the locking object control block

    \return upon successful creation the function should return 0
            Otherwise, a negative value indicating the error code shall be
   returned
    \note       belongs to \ref proting_sec
    \warning
*/
#define sl_LockObjCreate(pLockObj, pName)

/*!
    \brief  This function deletes a locking object.

    \param  pLockObj    -   pointer to the locking object control block

    \return upon successful deletion the function should return 0
            Otherwise, a negative value indicating the error code shall be
   returned
    \note       belongs to \ref proting_sec
    \warning
*/
#define sl_LockObjDelete(pLockObj)

/*!
    \brief  This function locks a locking object.

    All other threads that call this function before this thread calls
    the osi_LockObjUnlock would be suspended

    \param  pLockObj    -   pointer to the locking object control block
    \param  Timeout     -   numeric value specifies the maximum number of mSec
   to
                            stay suspended while waiting for the locking object
                            Currently, the simple link driver uses only two
   values:
                                - OSI_WAIT_FOREVER
                                - OSI_NO_WAIT


    \return upon successful reception of the locking object the function should
   return 0
            Otherwise, a negative value indicating the error code shall be
   returned
    \note       belongs to \ref proting_sec
    \warning
*/
#define sl_LockObjLock(pLockObj, Timeout)

/*!
    \brief  This function unlock a locking object.

    \param  pLockObj    -   pointer to the locking object control block

    \return upon successful unlocking the function should return 0
            Otherwise, a negative value indicating the error code shall be
   returned
    \note       belongs to \ref proting_sec
    \warning
*/
#define sl_LockObjUnlock(pLockObj)

#endif
/*!
    \brief  This function call the pEntry callback from a different context

    \param  pEntry      -   pointer to the entry callback function

    \param  pValue      -   pointer to any type of memory structure that would
   be
                            passed to pEntry callback from the execution thread.

    \param  flags       -   execution flags - reserved for future usage

    \return upon successful registration of the spawn the function should return
   0
            (the function is not blocked till the end of the execution of the
   function
            and could be returned before the execution is actually completed)
            Otherwise, a negative value indicating the error code shall be
   returned
    \note       belongs to \ref proting_sec
    \warning
*/
/*
#define SL_PLATFORM_EXTERNAL_SPAWN
*/

#ifdef SL_PLATFORM_EXTERNAL_SPAWN
#define sl_Spawn(pEntry, pValue, flags)
#endif

/*!

 Close the Doxygen group.
 @}

 */

/*!
 ******************************************************************************

    \defgroup       porting_events      Porting - Event Handlers

    This section includes the asynchronous event handlers routines

    PORTING ACTION:
        -Uncomment the required handler and define your routine as the value
        of this handler

    @{

 ******************************************************************************
 */

/*!
    \brief

    \sa

    \note       belongs to \ref proting_sec

    \warning
*/
/*
#define sl_GeneralEvtHdlr
 */

/*!
    \brief          An event handler for WLAN connection or disconnection
   indication
                    This event handles async WLAN events.
                    Possible events are:
                    SL_WLAN_CONNECT_EVENT - indicates WLAN is connected
                    SL_WLAN_DISCONNECT_EVENT - indicates WLAN is disconnected
    \sa

    \note           belongs to \ref proting_sec

    \warning
*/
#define sl_WlanEvtHdlr SimpleLinkWlanEventHandler

/*!
    \brief          An event handler for IP address asynchronous event. Usually
   accepted after new WLAN connection.
                    This event handles networking events.
                    Possible events are:
                    SL_NETAPP_IPV4_ACQUIRED - IP address was acquired (DHCP or
   Static)

    \sa

    \note           belongs to \ref proting_sec

    \warning
*/

#define sl_NetAppEvtHdlr SimpleLinkNetAppEventHandler

/*!
    \brief      A callback for HTTP server events.
                Possible events are:
                SL_NETAPP_HTTPGETTOKENVALUE - NWP requests to get the value of
                a specific token SL_NETAPP_HTTPPOSTTOKENVALUE - NWP post to the
                host a new value for a specific token

    \param      pServerEvent - Contains the relevant event information
                (SL_NETAPP_HTTPGETTOKENVALUE or SL_NETAPP_HTTPPOSTTOKENVALUE)

    \param      pServerResponse - Should be filled by the user with the relevant
                response information (i.e SL_NETAPP_HTTPSETTOKENVALUE as a
                response to SL_NETAPP_HTTPGETTOKENVALUE event)

    \sa

    \note       belongs to \ref proting_sec

    \warning
*/

// #define sl_HttpServerCallback        SimpleLinkHttpServerCallback
/*!
    \brief

    \sa

    \note           belongs to \ref proting_sec

    \warning
*/
/*
#define sl_SockEvtHdlr
*/

/*!
    \brief

    \sa

    \note           belongs to \ref porting_sec

    \warning
*/

#define sl_AsyncCmdHdlr SimpleLinkCmdHandler

#define SL_STORE_RESTORE_CONTEXT
#ifdef SL_STORE_RESTORE_CONTEXT
#define sl_SuspenedStoreContext SimpleLinkSuspenedStoreContextHandler
#define sl_ResumeRestoreContext SimpleLinkResumeRestoreContextHandler
#endif

/*!

 Close the Doxygen group.
 @}

 */

#ifdef __cplusplus
}
#endif  // __cplusplus

#endif  // __USER_H__