osdp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Siddharth Chandrasekaran <siddharth@embedjournal.com>
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_MGMT_OSDP_H_
#define ZEPHYR_INCLUDE_MGMT_OSDP_H_
 
#include <zephyr/kernel.h>
#include <stdint.h>
 
#include <zephyr/sys/slist.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define OSDP_CMD_TEXT_MAX_LEN          32 
#define OSDP_CMD_KEYSET_KEY_MAX_LEN    32 
#define OSDP_EVENT_MAX_DATALEN         64 
struct osdp_cmd_output {
        uint8_t output_no;
        uint8_t control_code;
        uint16_t timer_count;
};
 
enum osdp_led_color_e {
        OSDP_LED_COLOR_NONE,     
        OSDP_LED_COLOR_RED,      
        OSDP_LED_COLOR_GREEN,    
        OSDP_LED_COLOR_AMBER,    
        OSDP_LED_COLOR_BLUE,     
        OSDP_LED_COLOR_SENTINEL  
};
 
struct osdp_cmd_led_params {
        uint8_t control_code;
        uint8_t on_count;
        uint8_t off_count;
        uint8_t on_color;
        uint8_t off_color;
        uint16_t timer_count;
};
 
struct osdp_cmd_led {
        uint8_t reader;
        uint8_t led_number;
        struct osdp_cmd_led_params temporary;
        struct osdp_cmd_led_params permanent;
};
 
struct osdp_cmd_buzzer {
        uint8_t reader;
        uint8_t control_code;
        uint8_t on_count;
        uint8_t off_count;
        uint8_t rep_count;
};
 
struct osdp_cmd_text {
        uint8_t reader;
        uint8_t control_code;
        uint8_t temp_time;
        uint8_t offset_row;
        uint8_t offset_col;
        uint8_t length;
        uint8_t data[OSDP_CMD_TEXT_MAX_LEN];
};
 
struct osdp_cmd_comset {
        uint8_t address;
        uint32_t baud_rate;
};
 
struct osdp_cmd_keyset {
        uint8_t type;
        uint8_t length;
        uint8_t data[OSDP_CMD_KEYSET_KEY_MAX_LEN];
};
 
enum osdp_cmd_e {
        OSDP_CMD_OUTPUT = 1,  
        OSDP_CMD_LED,         
        OSDP_CMD_BUZZER,      
        OSDP_CMD_TEXT,        
        OSDP_CMD_KEYSET,      
        OSDP_CMD_COMSET,      
        OSDP_CMD_SENTINEL     
};
 
struct osdp_cmd {
        sys_snode_t node;
        enum osdp_cmd_e id;
        union {
                struct osdp_cmd_led    led;    
                struct osdp_cmd_buzzer buzzer; 
                struct osdp_cmd_text   text;   
                struct osdp_cmd_output output; 
                struct osdp_cmd_comset comset; 
                struct osdp_cmd_keyset keyset; 
        };
};
 
enum osdp_event_cardread_format_e {
        OSDP_CARD_FMT_RAW_UNSPECIFIED, 
        OSDP_CARD_FMT_RAW_WIEGAND,     
        OSDP_CARD_FMT_ASCII,           
        OSDP_CARD_FMT_SENTINEL         
};
 
struct osdp_event_cardread {
        int reader_no;
        enum osdp_event_cardread_format_e format;
        int direction;
        int length;
        uint8_t data[OSDP_EVENT_MAX_DATALEN];
};
 
struct osdp_event_keypress {
        int reader_no;
        int length;
        uint8_t data[OSDP_EVENT_MAX_DATALEN];
};
 
enum osdp_event_type {
        OSDP_EVENT_CARDREAD,  
        OSDP_EVENT_KEYPRESS,  
        OSDP_EVENT_SENTINEL   
};
 
struct osdp_event {
        sys_snode_t node;
        enum osdp_event_type type;
        union {
                struct osdp_event_keypress keypress; 
                struct osdp_event_cardread cardread; 
        };
};
 
typedef int (*pd_command_callback_t)(void *arg, struct osdp_cmd *cmd);
 
typedef int (*cp_event_callback_t)(void *arg, int pd, struct osdp_event *ev);
 
#if defined(CONFIG_OSDP_MODE_PD) || defined(__DOXYGEN__)
 
void osdp_pd_set_command_callback(pd_command_callback_t cb, void *arg);
 
int osdp_pd_notify_event(const struct osdp_event *event);
 
#else /* CONFIG_OSDP_MODE_PD */
 
int osdp_cp_send_command(int pd, struct osdp_cmd *cmd);
 
 
void osdp_cp_set_event_callback(cp_event_callback_t cb, void *arg);
 
#endif /* CONFIG_OSDP_MODE_PD */
 
#if defined(CONFIG_OSDP_SC_ENABLED) || defined(__DOXYGEN__)
 
uint32_t osdp_get_sc_status_mask(void);
 
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif  /* ZEPHYR_INCLUDE_MGMT_OSDP_H_ */