fwupd/plugins/dfu/dfu-element.c
2019-11-01 14:21:20 +00:00

171 lines
3.7 KiB
C

/*
* Copyright (C) 2015 Richard Hughes <richard@hughsie.com>
*
* SPDX-License-Identifier: LGPL-2.1+
*/
/**
* SECTION:dfu-element
* @short_description: Object representing a binary element
*
* This object represents an binary blob of data at a specific address.
*
* This allows relocatable data segments to be stored in different
* locations on the device itself.
*
* See also: #DfuImage, #DfuFirmware
*/
#include "config.h"
#include <string.h>
#include <stdio.h>
#include "dfu-common.h"
#include "dfu-element.h"
#include "fwupd-error.h"
static void dfu_element_finalize (GObject *object);
typedef struct {
GBytes *contents;
guint32 address;
} DfuElementPrivate;
G_DEFINE_TYPE_WITH_PRIVATE (DfuElement, dfu_element, G_TYPE_OBJECT)
#define GET_PRIVATE(o) (dfu_element_get_instance_private (o))
static void
dfu_element_class_init (DfuElementClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->finalize = dfu_element_finalize;
}
static void
dfu_element_init (DfuElement *element)
{
}
static void
dfu_element_finalize (GObject *object)
{
DfuElement *element = DFU_ELEMENT (object);
DfuElementPrivate *priv = GET_PRIVATE (element);
if (priv->contents != NULL)
g_bytes_unref (priv->contents);
G_OBJECT_CLASS (dfu_element_parent_class)->finalize (object);
}
/**
* dfu_element_new:
*
* Creates a new DFU element object.
*
* Return value: a new #DfuElement
**/
DfuElement *
dfu_element_new (void)
{
DfuElement *element;
element = g_object_new (DFU_TYPE_ELEMENT, NULL);
return element;
}
/**
* dfu_element_get_contents:
* @element: a #DfuElement
*
* Gets the element data.
*
* Return value: (transfer none): element data
**/
GBytes *
dfu_element_get_contents (DfuElement *element)
{
DfuElementPrivate *priv = GET_PRIVATE (element);
g_return_val_if_fail (DFU_IS_ELEMENT (element), NULL);
return priv->contents;
}
/**
* dfu_element_get_address:
* @element: a #DfuElement
*
* Gets the offset address of the element.
*
* Return value: memory offset value, or 0x00 for unset
**/
guint32
dfu_element_get_address (DfuElement *element)
{
DfuElementPrivate *priv = GET_PRIVATE (element);
g_return_val_if_fail (DFU_IS_ELEMENT (element), 0x00);
return priv->address;
}
/**
* dfu_element_set_contents:
* @element: a #DfuElement
* @contents: element data
*
* Sets the element data.
**/
void
dfu_element_set_contents (DfuElement *element, GBytes *contents)
{
DfuElementPrivate *priv = GET_PRIVATE (element);
g_return_if_fail (DFU_IS_ELEMENT (element));
g_return_if_fail (contents != NULL);
if (priv->contents == contents)
return;
if (priv->contents != NULL)
g_bytes_unref (priv->contents);
priv->contents = g_bytes_ref (contents);
}
/**
* dfu_element_set_address:
* @element: a #DfuElement
* @address: memory offset value
*
* Sets the offset address of the element.
**/
void
dfu_element_set_address (DfuElement *element, guint32 address)
{
DfuElementPrivate *priv = GET_PRIVATE (element);
g_return_if_fail (DFU_IS_ELEMENT (element));
priv->address = address;
}
/**
* dfu_element_to_string:
* @element: a #DfuElement
*
* Returns a string representation of the object.
*
* Return value: NULL terminated string, or %NULL for invalid
**/
gchar *
dfu_element_to_string (DfuElement *element)
{
DfuElementPrivate *priv = GET_PRIVATE (element);
GString *str;
g_return_val_if_fail (DFU_IS_ELEMENT (element), NULL);
str = g_string_new ("");
g_string_append_printf (str, "address: 0x%02x\n", priv->address);
if (priv->contents != NULL) {
g_string_append_printf (str, "contents: 0x%04x\n",
(guint32) g_bytes_get_size (priv->contents));
}
g_string_truncate (str, str->len - 1);
return g_string_free (str, FALSE);
}