summaryrefslogtreecommitdiffstats
path: root/mnsl/mns_segmentation.h
diff options
context:
space:
mode:
Diffstat (limited to 'mnsl/mns_segmentation.h')
-rw-r--r--mnsl/mns_segmentation.h146
1 files changed, 146 insertions, 0 deletions
diff --git a/mnsl/mns_segmentation.h b/mnsl/mns_segmentation.h
new file mode 100644
index 0000000..1295be3
--- /dev/null
+++ b/mnsl/mns_segmentation.h
@@ -0,0 +1,146 @@
+/*
+ * MOST NetServices "Light" V3.2.7.0.1796 MultiInstance Patch
+ *
+ * Copyright (C) 2015 Microchip Technology Germany II GmbH & Co. KG
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * You may also obtain this software under a propriety license from Microchip.
+ * Please contact Microchip for further information.
+ *
+ */
+
+/*!
+ * \file
+ * \brief Internal header file of AMS Segmentation Class
+ *
+ * \cond MNS_INTERNAL_DOC
+ * \addtogroup G_AMSSEGM
+ * @{
+ */
+
+#ifndef MNS_SEGMENTATION_H
+#define MNS_SEGMENTATION_H
+
+/*------------------------------------------------------------------------------------------------*/
+/* Includes */
+/*------------------------------------------------------------------------------------------------*/
+#include "mns_message.h"
+#include "mns_amsmessage.h"
+#include "mns_amspool.h"
+#include "mns_base.h"
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+/*------------------------------------------------------------------------------------------------*/
+/* Macros */
+/*------------------------------------------------------------------------------------------------*/
+/*! \brief Defines the maximum payload size of a single transfer in bytes */
+#define SEGM_MAX_SIZE_TEL 45U
+
+/*------------------------------------------------------------------------------------------------*/
+/* Types */
+/*------------------------------------------------------------------------------------------------*/
+/*! \brief Collection of possible segmentation errors */
+typedef enum Segm_Error_
+{
+ SEGM_ERR_1 = 1, /*!< \brief The first segment is missing. */
+
+ SEGM_ERR_2 = 2, /*!< \brief The device is not able to receive a message of this size.
+ * MNS specific: The allocation of user provided payload failed.
+ */
+ SEGM_ERR_3 = 3, /*!< \brief Unexpected segment number. */
+
+ SEGM_ERR_4 = 4, /*!< \brief Too many unfinished segmentation messages were pending. */
+
+ SEGM_ERR_5 = 5, /*!< \brief A timeout occurred while waiting for the next segment. */
+
+ SEGM_ERR_6 = 6, /*!< \brief The Device is not capable to handle segmented messages.
+ * MNS specific: The application did not assign the payload allocation
+ * function in Mns_Ams_InitData_t prior calling Mns_Init().
+ */
+ SEGM_ERR_7 = 7 /*!< \brief Segmented message has not been finished before the arrival of
+ * another message with the identical FBlockID, InstID, FktID, and
+ * OPType sent by the same node.
+ */
+} Segm_Error_t;
+
+/*! \brief Segmentation result */
+typedef enum Segm_Result_
+{
+ SEGM_RES_OK, /*!< \brief Telegram was processed */
+ SEGM_RES_RETRY /*!< \brief Telegram shall be processed again as soon as messages are freed to the Rx pool */
+
+} Segm_Result_t;
+
+/*! \brief Callback function to notify that a segmentation error has occurred
+ * \param self The instance
+ * \param tel_ptr The affected telegram
+ * \param error The segmentation error code (1..7)
+ */
+typedef void (*Segm_OnError_t)(void *self, Msg_MostTel_t *tel_ptr, Segm_Error_t error);
+
+/*------------------------------------------------------------------------------------------------*/
+/* Class */
+/*------------------------------------------------------------------------------------------------*/
+/*! \brief AMS Segmentation Class
+ * \details Performs Tx and Rx Segmentation
+ */
+typedef struct CSegmentation_
+{
+ CBase *base_ptr; /*!< \brief Reference to base services */
+ CAmsMsgPool *pool_ptr; /*!< \brief Reference to object/payload pool */
+
+ Segm_OnError_t error_fptr; /*!< \brief Callback function to notify segmentation errors */
+ void *error_inst; /*!< \brief Instance which is notified on segmentation errors */
+
+ CDlList processing_list; /*!< \brief Segmented and un-finished Rx messages */
+ CTimer gc_timer; /*!< \brief Timer to trigger the garbage collector */
+ uint16_t rx_default_payload_sz; /*!< \brief Payload size that shall be allocated if size-prefixes
+ * segmentation message is missing */
+
+} CSegmentation;
+
+/*------------------------------------------------------------------------------------------------*/
+/* Initialization Methods */
+/*------------------------------------------------------------------------------------------------*/
+extern void Segm_Ctor(CSegmentation *self, CBase *base_ptr, CAmsMsgPool *pool_ptr, uint16_t rx_def_payload_sz);
+extern void Segm_AssignRxErrorHandler(CSegmentation *self, Segm_OnError_t error_fptr, void *error_inst);
+extern void Segm_Cleanup(CSegmentation *self);
+
+/*------------------------------------------------------------------------------------------------*/
+/* Public method prototypes */
+/*------------------------------------------------------------------------------------------------*/
+extern bool Segm_TxBuildSegment(CSegmentation *self, Mns_AmsTx_Msg_t *msg_ptr, Msg_MostTel_t *tel_ptr);
+extern Mns_AmsRx_Msg_t* Segm_RxExecuteSegmentation(CSegmentation *self, Msg_MostTel_t *tel_ptr, Segm_Result_t *result_ptr);
+extern void Segm_RxGcScanProcessingHandles(void *self);
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif /* MNS_SEGMENTATION_H */
+
+/*!
+ * @}
+ * \endcond
+ */
+
+/*------------------------------------------------------------------------------------------------*/
+/* End of file */
+/*------------------------------------------------------------------------------------------------*/
+