libosdp 3.0.4__tar.gz → 3.0.6__tar.gz

{libosdp-3.0.4 → libosdp-3.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: libosdp
-Version: 3.0.4
+Version: 3.0.6
 Summary: Library implementation of IEC 60839-11-5 OSDP (Open Supervised Device Protocol)
 Home-page: https://github.com/goToMain/libosdp
 Author: Siddharth Chandrasekaran

{libosdp-3.0.4 → libosdp-3.0.6}/libosdp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: libosdp
-Version: 3.0.4
+Version: 3.0.6
 Summary: Library implementation of IEC 60839-11-5 OSDP (Open Supervised Device Protocol)
 Home-page: https://github.com/goToMain/libosdp
 Author: Siddharth Chandrasekaran

{libosdp-3.0.4 → libosdp-3.0.6}/setup.py

@@ -11,7 +11,7 @@ import shutil
 import subprocess
 
 project_name = "libosdp"
-project_version = "3.0.4"
+project_version = "3.0.6"
 current_dir = os.path.dirname(os.path.realpath(__file__))
 repo_root = os.path.realpath(os.path.join(current_dir, ".."))
 

{libosdp-3.0.4 → libosdp-3.0.6}/vendor/include/osdp.h

@@ -14,6 +14,7 @@
 
 #include <stdint.h>
 #include <stdbool.h>
+#include <osdp_export.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -368,14 +369,19 @@ enum osdp_status_report_type {
  *
  * This can is used by the PD to indicate various status change reports. Upto a
  * maximum of 32 statuses can be reported using this API.
- *
- * @param type The kind of event to report see `enum osdp_event_status_type_e`
- * @param nr_entries Number of valid bits in `status`
- * @param status Status bit mask
  */
 struct osdp_status_report {
+	/**
+	 * The kind of event to report see `enum osdp_event_status_type_e`
+	 */
 	enum osdp_status_report_type type;
+	/**
+	 * Number of valid bits in `status`
+	 */
 	int nr_entries;
+	/**
+	 * Status bit mask
+	 */
 	uint32_t mask;
 };
 
@@ -391,21 +397,26 @@ struct osdp_status_report {
 
 /**
  * @brief Command sent from CP to Control digital output of PD.
- *
- * @param output_no 0 = First Output, 1 = Second Output, etc.
- * @param control_code One of the following:
- *    0 - NOP – do not alter this output
- *    1 - set the permanent state to OFF, abort timed operation (if any)
- *    2 - set the permanent state to ON, abort timed operation (if any)
- *    3 - set the permanent state to OFF, allow timed operation to complete
- *    4 - set the permanent state to ON, allow timed operation to complete
- *    5 - set the temporary state to ON, resume perm state on timeout
- *    6 - set the temporary state to OFF, resume permanent state on timeout
- * @param timer_count Time in units of 100 ms
  */
 struct osdp_cmd_output {
+	/**
+	 * 0 = First Output, 1 = Second Output, etc.
+	 */
 	uint8_t output_no;
+	/**
+	 * One of the following:
+	 *    0 - NOP – do not alter this output
+	 *    1 - set the permanent state to OFF, abort timed operation (if any)
+	 *    2 - set the permanent state to ON, abort timed operation (if any)
+	 *    3 - set the permanent state to OFF, allow timed operation to complete
+	 *    4 - set the permanent state to ON, allow timed operation to complete
+	 *    5 - set the temporary state to ON, resume perm state on timeout
+	 *    6 - set the temporary state to OFF, resume permanent state on timeout
+	 */
 	uint8_t control_code;
+	/**
+	 * Time in units of 100 ms
+	 */
 	uint16_t timer_count;
 };
 
@@ -573,11 +584,6 @@ struct osdp_cmd_comset {
 
 /**
  * @brief This command transfers an encryption key from the CP to a PD.
- *
- * @param type Type of keys:
- *   - 0x01 – Secure Channel Base Key
- * @param length Number of bytes of key data - (Key Length in bits + 7) / 8
- * @param data Key data
  */
 struct osdp_cmd_keyset {
 	/**
@@ -597,17 +603,23 @@ struct osdp_cmd_keyset {
 
 /**
  * @brief Manufacturer Specific Commands
- *
- * @param vendor_code 3-byte IEEE assigned OUI. Most Significant 8-bits are
- *        unused.
- * @param command 1-byte manufacturer defined osdp command
- * @param length Length of command data (optional)
- * @param data Command data (optional)
  */
 struct osdp_cmd_mfg {
+	/**
+	 * 3-byte IEEE assigned OUI. Most Significant 8-bits are unused
+	 */
 	uint32_t vendor_code;
+	/**
+	 * 1-byte manufacturer defined osdp command
+	 */
 	uint8_t command;
+	/**
+	 * length Length of command data (optional)
+	 */
 	uint8_t length;
+	/**
+	 * Command data (optional)
+	 */
 	uint8_t data[OSDP_CMD_MFG_MAX_DATALEN];
 };
 
@@ -842,6 +854,7 @@ typedef int (*cp_event_callback_t)(void *arg, int pd, struct osdp_event *ev);
  * @retval OSDP Context on success
  * @retval NULL on errors
  */
+OSDP_EXPORT
 osdp_t *osdp_pd_setup(const osdp_pd_info_t *info);
 
 /**
@@ -850,6 +863,7 @@ osdp_t *osdp_pd_setup(const osdp_pd_info_t *info);
  *
  * @param ctx OSDP context
  */
+OSDP_EXPORT
 void osdp_pd_refresh(osdp_t *ctx);
 
 /**
@@ -858,6 +872,7 @@ void osdp_pd_refresh(osdp_t *ctx);
  *
  * @param ctx OSDP context
  */
+OSDP_EXPORT
 void osdp_pd_teardown(osdp_t *ctx);
 
 /**
@@ -867,6 +882,7 @@ void osdp_pd_teardown(osdp_t *ctx);
  * @param cap pointer to array of cap (`struct osdp_pd_cap`) terminated by a
  * capability with cap->function_code set to 0.
  */
+OSDP_EXPORT
 void osdp_pd_set_capabilities(osdp_t *ctx, const struct osdp_pd_cap *cap);
 
 /**
@@ -877,6 +893,7 @@ void osdp_pd_set_capabilities(osdp_t *ctx, const struct osdp_pd_cap *cap);
  * @param cb The callback function's pointer
  * @param arg A pointer that will be passed as the first argument of `cb`
  */
+OSDP_EXPORT
 void osdp_pd_set_command_callback(osdp_t *ctx, pd_command_callback_t cb,
 				  void *arg);
 
@@ -890,6 +907,7 @@ void osdp_pd_set_command_callback(osdp_t *ctx, pd_command_callback_t cb,
  * @retval 0 on success
  * @retval -1 on failure
  */
+OSDP_EXPORT
 int osdp_pd_notify_event(osdp_t *ctx, const struct osdp_event *event);
 
 /**
@@ -898,6 +916,7 @@ int osdp_pd_notify_event(osdp_t *ctx, const struct osdp_event *event);
  * @param ctx OSDP context
  * @return int Count of events dequeued.
  */
+OSDP_EXPORT
 int osdp_pd_flush_events(osdp_t *ctx);
 
 /* ------------------------------- */
@@ -916,6 +935,7 @@ int osdp_pd_flush_events(osdp_t *ctx);
  * @retval OSDP Context on success
  * @retval NULL on errors
  */
+OSDP_EXPORT
 osdp_t *osdp_cp_setup(int num_pd, const osdp_pd_info_t *info);
 
 /**
@@ -924,6 +944,7 @@ osdp_t *osdp_cp_setup(int num_pd, const osdp_pd_info_t *info);
  *
  * @param ctx OSDP context
  */
+OSDP_EXPORT
 void osdp_cp_refresh(osdp_t *ctx);
 
 /**
@@ -932,6 +953,7 @@ void osdp_cp_refresh(osdp_t *ctx);
  *
  * @param ctx OSDP context
  */
+OSDP_EXPORT
 void osdp_cp_teardown(osdp_t *ctx);
 
 /**
@@ -948,6 +970,7 @@ void osdp_cp_teardown(osdp_t *ctx);
  * @note This method only adds the command on to a particular PD's command
  * queue. The command itself can fail due to various reasons.
  */
+OSDP_EXPORT
 int osdp_cp_send_command(osdp_t *ctx, int pd, const struct osdp_cmd *cmd);
 
 /**
@@ -958,6 +981,7 @@ int osdp_cp_send_command(osdp_t *ctx, int pd, const struct osdp_cmd *cmd);
  * osdp_cp_setup()
  * @return int Count of events dequeued
  */
+OSDP_EXPORT
 int osdp_cp_flush_commands(osdp_t *ctx, int pd);
 
 /**
@@ -974,6 +998,7 @@ int osdp_cp_flush_commands(osdp_t *ctx, int pd);
  * @retval 0 on success
  * @retval -1 on failure
  */
+OSDP_EXPORT
 int osdp_cp_get_pd_id(const osdp_t *ctx, int pd, struct osdp_pd_id *id);
 
 /**
@@ -990,6 +1015,7 @@ int osdp_cp_get_pd_id(const osdp_t *ctx, int pd, struct osdp_pd_id *id);
  * @retval 0 on success
  * @retval -1 on failure
  */
+OSDP_EXPORT
 int osdp_cp_get_capability(const osdp_t *ctx, int pd, struct osdp_pd_cap *cap);
 
 /**
@@ -1000,6 +1026,7 @@ int osdp_cp_get_capability(const osdp_t *ctx, int pd, struct osdp_pd_cap *cap);
  * @param cb The callback function's pointer
  * @param arg A pointer that will be passed as the first argument of `cb`
  */
+OSDP_EXPORT
 void osdp_cp_set_event_callback(osdp_t *ctx, cp_event_callback_t cb, void *arg);
 
 /**
@@ -1018,6 +1045,7 @@ void osdp_cp_set_event_callback(osdp_t *ctx, cp_event_callback_t cb, void *arg);
  * @note It doesn't make sense to call some initialization time flags during
  * runtime. This method is for dynamic flags that can be turned on/off at runtime.
  */
+OSDP_EXPORT
 int osdp_cp_modify_flag(osdp_t *ctx, int pd, uint32_t flags, bool do_set);
 
 /* ------------------------------- */
@@ -1075,6 +1103,7 @@ typedef void (*osdp_log_callback_fn_t)(int log_level, const char *file,
  * Note: This function has to be called before osdp_{cp,pd}_setup(). Otherwise
  *       it will be ignored.
  */
+OSDP_EXPORT
 void osdp_logger_init(const char *name, int log_level,
 		      osdp_log_puts_fn_t puts_fn);
 
@@ -1090,6 +1119,7 @@ void osdp_logger_init(const char *name, int log_level,
  * @note This function has to be called before osdp_{cp,pd}_setup(). Otherwise
  * it will be ignored.
  */
+OSDP_EXPORT
 void osdp_set_log_callback(osdp_log_callback_fn_t cb);
 
 /**
@@ -1097,6 +1127,7 @@ void osdp_set_log_callback(osdp_log_callback_fn_t cb);
  *
  * @retval version string
  */
+OSDP_EXPORT
 const char *osdp_get_version();
 
 /**
@@ -1106,6 +1137,7 @@ const char *osdp_get_version();
  *
  * @retval source identifier string
  */
+OSDP_EXPORT
 const char *osdp_get_source_info();
 
 /**
@@ -1115,6 +1147,7 @@ const char *osdp_get_source_info();
  * @param bitmask pointer to an array of bytes. must be as large as
  * (num_pds + 7 / 8).
  */
+OSDP_EXPORT
 void osdp_get_status_mask(const osdp_t *ctx, uint8_t *bitmask);
 
 /**
@@ -1125,6 +1158,7 @@ void osdp_get_status_mask(const osdp_t *ctx, uint8_t *bitmask);
  * @param bitmask pointer to an array of bytes. must be as large as
  * (num_pds + 7 / 8).
  */
+OSDP_EXPORT
 void osdp_get_sc_status_mask(const osdp_t *ctx, uint8_t *bitmask);
 
 /**
@@ -1219,7 +1253,8 @@ struct osdp_file_ops {
  *
  * @retval 0 on success. -1 on errors.
  */
-int osdp_file_register_ops(osdp_t *ctx, int pd_idx,
+OSDP_EXPORT
+int osdp_file_register_ops(osdp_t *ctx, int pd,
 			   const struct osdp_file_ops *ops);
 
 /**
@@ -1232,8 +1267,8 @@ int osdp_file_register_ops(osdp_t *ctx, int pd_idx,
  * @param offset Offset into the file that has been sent/received (CP/PD)
  * @retval 0 on success. -1 on errors.
  */
-int osdp_get_file_tx_status(const osdp_t *ctx, int pd_idx,
-			    int *size, int *offset);
+OSDP_EXPORT
+int osdp_get_file_tx_status(const osdp_t *ctx, int pd, int *size, int *offset);
 
 #ifdef __cplusplus
 }

{libosdp-3.0.4 → libosdp-3.0.6}/vendor/src/osdp_common.c

@@ -3,6 +3,11 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+
+#ifndef _GNU_SOURCE
+#define _GNU_SOURCE /* See feature_test_macros(7) */
+#endif
+
 #include <stdarg.h>
 #include <stdlib.h>
 #ifndef CONFIG_DISABLE_PRETTY_LOGGING
@@ -218,9 +223,9 @@ const char *osdp_get_version()
 OSDP_EXPORT
 const char *osdp_get_source_info()
 {
-	if (strnlen(GIT_TAG, 8) > 0) {
+	if (strlen(GIT_TAG) > 0) {
 		return GIT_BRANCH " (" GIT_TAG ")";
-	} else if (strnlen(GIT_REV, 8) > 0) {
+	} else if (strlen(GIT_REV) > 0) {
 		return GIT_BRANCH " (" GIT_REV GIT_DIFF ")";
 	} else {
 		return GIT_BRANCH;

{libosdp-3.0.4 → libosdp-3.0.6}/vendor/src/osdp_config.h

@@ -11,11 +11,11 @@
  * @brief The following macros are defined defined from the variable in cmake
  * files. All @XXX@ are replaced by the value of XXX as resolved by cmake.
  */
-#define PROJECT_VERSION                "3.0.4"
+#define PROJECT_VERSION                "3.0.6"
 #define PROJECT_NAME                   "libosdp"
-#define GIT_BRANCH                     "HEAD"
-#define GIT_REV                        "ca56683"
-#define GIT_TAG                        "v3.0.4"
+#define GIT_BRANCH                     "master"
+#define GIT_REV                        "cf675a0"
+#define GIT_TAG                        ""
 #define GIT_DIFF                       ""
 #define REPO_ROOT                      "/home/runner/work/libosdp/libosdp"
 

{libosdp-3.0.4 → libosdp-3.0.6}/vendor/src/osdp_pd.c

@@ -305,7 +305,7 @@ static int pd_decode_command(struct osdp_pd *pd, uint8_t *buf, int len)
 		}
 		cmd.id = OSDP_CMD_STATUS;
 		cmd.status.type = OSDP_STATUS_REPORT_LOCAL;
-		if (do_command_callback(pd, &cmd)) {
+		if (!do_command_callback(pd, &cmd)) {
 			break;
 		}
 		event = (struct osdp_event *)pd->ephemeral_data;
@@ -324,7 +324,7 @@ static int pd_decode_command(struct osdp_pd *pd, uint8_t *buf, int len)
 		}
 		cmd.id = OSDP_CMD_STATUS;
 		cmd.status.type = OSDP_STATUS_REPORT_INPUT;
-		if (do_command_callback(pd, &cmd)) {
+		if (!do_command_callback(pd, &cmd)) {
 			break;
 		}
 		event = (struct osdp_event *)pd->ephemeral_data;
@@ -343,7 +343,7 @@ static int pd_decode_command(struct osdp_pd *pd, uint8_t *buf, int len)
 		}
 		cmd.id = OSDP_CMD_STATUS;
 		cmd.status.type = OSDP_STATUS_REPORT_OUTPUT;
-		if (do_command_callback(pd, &cmd)) {
+		if (!do_command_callback(pd, &cmd)) {
 			break;
 		}
 		event = (struct osdp_event *)pd->ephemeral_data;
@@ -358,7 +358,7 @@ static int pd_decode_command(struct osdp_pd *pd, uint8_t *buf, int len)
 		}
 		cmd.id = OSDP_CMD_STATUS;
 		cmd.status.type = OSDP_STATUS_REPORT_REMOTE;
-		if (do_command_callback(pd, &cmd)) {
+		if (!do_command_callback(pd, &cmd)) {
 			break;
 		}
 		event = (struct osdp_event *)pd->ephemeral_data;

{libosdp-3.0.4 → libosdp-3.0.6}/vendor/src/osdp_phy.c

@@ -518,8 +518,9 @@ int osdp_phy_check_packet(struct osdp_pd *pd)
 		}
 		pd->packet_len = ret;
 		if (pd->packet_scan_skip) {
-			LOG_WRN("Packet scan skipped %u bytes before SoM",
-				pd->packet_scan_skip);
+			LOG_WRN("Packet scan skipped:%u mark:%d",
+				pd->packet_scan_skip,
+				ISSET_FLAG(pd, PD_FLAG_PKT_HAS_MARK));
 			pd->packet_scan_skip = 0;
 		}
 	}