ubx.h

Go to the documentation of this file.

/*
 * Copyright 2024 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#include <zephyr/kernel.h>
#include <zephyr/types.h>
#include <zephyr/sys/atomic.h>
 
#include <zephyr/modem/pipe.h>
 
#ifndef ZEPHYR_MODEM_UBX_
#define ZEPHYR_MODEM_UBX_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define UBX_FRM_HEADER_SZ                       6
#define UBX_FRM_FOOTER_SZ                       2
#define UBX_FRM_SZ_WITHOUT_PAYLOAD              (UBX_FRM_HEADER_SZ + UBX_FRM_FOOTER_SZ)
#define UBX_FRM_SZ(payload_size)                (payload_size + UBX_FRM_SZ_WITHOUT_PAYLOAD)
 
#define UBX_PREAMBLE_SYNC_CHAR_1                0xB5
#define UBX_PREAMBLE_SYNC_CHAR_2                0x62
 
#define UBX_FRM_PREAMBLE_SYNC_CHAR_1_IDX        0
#define UBX_FRM_PREAMBLE_SYNC_CHAR_2_IDX        1
#define UBX_FRM_MSG_CLASS_IDX                   2
#define UBX_FRM_MSG_ID_IDX                      3
#define UBX_FRM_PAYLOAD_SZ_L_IDX                4
#define UBX_FRM_PAYLOAD_SZ_H_IDX                5
#define UBX_FRM_PAYLOAD_IDX                     6
#define UBX_FRM_CHECKSUM_START_IDX              2
#define UBX_FRM_CHECKSUM_STOP_IDX(frame_len)    (frame_len - 2)
 
#define UBX_PAYLOAD_SZ_MAX                      256
#define UBX_FRM_SZ_MAX                          UBX_FRM_SZ(UBX_PAYLOAD_SZ_MAX)
 
struct ubx_frame {
        uint8_t preamble_sync_char_1;
        uint8_t preamble_sync_char_2;
        uint8_t message_class;
        uint8_t message_id;
        uint8_t payload_size_low;
        uint8_t payload_size_high;
        uint8_t payload_and_checksum[];
};
 
struct modem_ubx_script {
        struct ubx_frame *request;
        struct ubx_frame *response;
        struct ubx_frame *match;
 
        uint16_t retry_count;
        k_timeout_t timeout;
};
 
struct modem_ubx {
        void *user_data;
 
        atomic_t state;
 
        uint8_t *receive_buf;
        uint16_t receive_buf_size;
 
        uint8_t *work_buf;
        uint16_t work_buf_size;
        uint16_t work_buf_len;
        bool ubx_preamble_sync_chars_received;
 
        const struct modem_ubx_script *script;
 
        struct modem_pipe *pipe;
 
        struct k_work send_work;
        struct k_work process_work;
        struct k_sem script_stopped_sem;
        struct k_sem script_running_sem;
};
 
struct modem_ubx_config {
        void *user_data;
 
        uint8_t *receive_buf;
        uint16_t receive_buf_size;
        uint8_t *work_buf;
        uint16_t work_buf_size;
};
 
int modem_ubx_attach(struct modem_ubx *ubx, struct modem_pipe *pipe);
 
void modem_ubx_release(struct modem_ubx *ubx);
 
int modem_ubx_init(struct modem_ubx *ubx, const struct modem_ubx_config *config);
 
int modem_ubx_run_script(struct modem_ubx *ubx, const struct modem_ubx_script *script);
 
int modem_ubx_create_frame(uint8_t *ubx_frame, uint16_t ubx_frame_size, uint8_t msg_cls,
                           uint8_t msg_id, const void *payload, uint16_t payload_size);
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_MODEM_UBX_ */