ucs2-lib/inc/ucs_amtp.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 /*!
  23  * \file
  24  * \brief Internal header file of Application Message Tx Pool
  25  *
  26  * \cond UCS_INTERNAL_DOC
  27  * \addtogroup G_AMTP
  28  * @{
  29  */
  30
  31 #ifndef UCS_AMSP_H
  32 #define UCS_AMSP_H
  33
  34 /*------------------------------------------------------------------------------------------------*/
  35 /* Includes                                                                                       */
  36 /*------------------------------------------------------------------------------------------------*/
  37 #include "ucs_base.h"
  38 #include "ucs_amsmessage.h"
  39
  40 #ifdef __cplusplus
  41 extern "C"
  42 {
  43 #endif
  44
  45 /*------------------------------------------------------------------------------------------------*/
  46 /* Types                                                                                          */
  47 /*------------------------------------------------------------------------------------------------*/
  48
  49
  50 /*------------------------------------------------------------------------------------------------*/
  51 /* Class                                                                                          */
  52 /*------------------------------------------------------------------------------------------------*/
  53 /*! \brief      Application Message Tx Pool Class
  54  *  \details    Provides a predefined number of Tx message objects to an internal class
  55  */
  56 typedef struct CAmtp_
  57 {
  58     void    *ucs_user_ptr;      /*!< \brief User reference that needs to be passed in every callback function */
  59     CDlList  msg_queue;         /*!< \brief Queue of messages for the receiver */
  60
  61 } CAmtp;
  62
  63 /*------------------------------------------------------------------------------------------------*/
  64 /* Methods                                                                                        */
  65 /*------------------------------------------------------------------------------------------------*/
  66 extern void Amtp_Ctor(CAmtp *self, Amsg_IntMsgTx_t msg_ptr[], uint8_t data_ptr[], uint8_t msg_cnt, uint16_t payload_sz, void *ucs_user_ptr);
  67 extern Ucs_AmsTx_Msg_t* Amtp_AllocMsg(CAmtp *self);
  68
  69 #ifdef __cplusplus
  70 }               /* extern "C" */
  71 #endif
  72
  73 #endif          /* UCS_AMD_H */
  74
  75 /*!
  76  * @}
  77  * \endcond
  78  */
  79
  80 /*------------------------------------------------------------------------------------------------*/
  81 /* End of file                                                                                    */
  82 /*------------------------------------------------------------------------------------------------*/
  83