115 lines
4.6 KiB
C
115 lines
4.6 KiB
C
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
|
|
/*
|
|
* Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
* found in the LICENSE file.
|
|
*/
|
|
|
|
/*
|
|
* libqmi-glib -- GLib/GIO based library to control QMI devices
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library 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
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301 USA.
|
|
*
|
|
* Copyright (C) 2012 Aleksander Morgado <aleksander@lanedo.com>
|
|
*/
|
|
|
|
#ifndef _LIBQMI_GLIB_QMI_MESSAGE_H_
|
|
#define _LIBQMI_GLIB_QMI_MESSAGE_H_
|
|
|
|
#if !defined (__LIBQMI_GLIB_H_INSIDE__) && !defined (LIBQMI_GLIB_COMPILATION)
|
|
#error "Only <libqmi-glib.h> can be included directly."
|
|
#endif
|
|
|
|
#include <glib.h>
|
|
|
|
#include "qmi-enums.h"
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define QMI_MESSAGE_QMUX_MARKER (guint8)0x01
|
|
|
|
/**
|
|
* QmiMessage:
|
|
*
|
|
* An opaque type representing a QMI message.
|
|
*/
|
|
typedef GByteArray QmiMessage;
|
|
|
|
/*****************************************************************************/
|
|
/* QMI Message life cycle */
|
|
|
|
QmiMessage *qmi_message_new (QmiService service,
|
|
guint8 client_id,
|
|
guint16 transaction_id,
|
|
guint16 message_id);
|
|
QmiMessage *qmi_message_new_from_raw (GByteArray *raw,
|
|
GError **error);
|
|
QmiMessage *qmi_message_ref (QmiMessage *self);
|
|
void qmi_message_unref (QmiMessage *self);
|
|
|
|
/*****************************************************************************/
|
|
/* QMI Message content getters */
|
|
|
|
gboolean qmi_message_is_response (QmiMessage *self);
|
|
gboolean qmi_message_is_indication (QmiMessage *self);
|
|
QmiService qmi_message_get_service (QmiMessage *self);
|
|
guint8 qmi_message_get_client_id (QmiMessage *self);
|
|
guint16 qmi_message_get_transaction_id (QmiMessage *self);
|
|
guint16 qmi_message_get_message_id (QmiMessage *self);
|
|
gsize qmi_message_get_length (QmiMessage *self);
|
|
const guint8 *qmi_message_get_raw (QmiMessage *self,
|
|
gsize *length,
|
|
GError **error);
|
|
gboolean qmi_message_get_version_introduced (QmiMessage *self,
|
|
guint *major,
|
|
guint *minor);
|
|
|
|
/*****************************************************************************/
|
|
/* Raw TLV handling */
|
|
|
|
typedef void (* QmiMessageForeachRawTlvFn) (guint8 type,
|
|
const guint8 *value,
|
|
gsize length,
|
|
gpointer user_data);
|
|
void qmi_message_foreach_raw_tlv (QmiMessage *self,
|
|
QmiMessageForeachRawTlvFn func,
|
|
gpointer user_data);
|
|
const guint8 *qmi_message_get_raw_tlv (QmiMessage *self,
|
|
guint8 type,
|
|
guint16 *length);
|
|
gboolean qmi_message_add_raw_tlv (QmiMessage *self,
|
|
guint8 type,
|
|
const guint8 *raw,
|
|
gsize length,
|
|
GError **error);
|
|
|
|
/*****************************************************************************/
|
|
/* Printable helpers */
|
|
|
|
gchar *qmi_message_get_printable (QmiMessage *self,
|
|
const gchar *line_prefix);
|
|
|
|
gchar *qmi_message_get_tlv_printable (QmiMessage *self,
|
|
const gchar *line_prefix,
|
|
guint8 type,
|
|
const guint8 *raw,
|
|
gsize raw_length);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* _LIBQMI_GLIB_QMI_MESSAGE_H_ */
|