Coverage Report

Created: 2025-12-14 06:56

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/fwupd/plugins/synaptics-mst/fu-synaptics-mst-firmware.c
Line
Count
Source
1
/*
2
 * Copyright 2021 Richard Hughes <richard@hughsie.com>
3
 *
4
 * SPDX-License-Identifier: LGPL-2.1-or-later
5
 */
6
7
#include "config.h"
8
9
#include "fu-synaptics-mst-common.h"
10
#include "fu-synaptics-mst-firmware.h"
11
12
struct _FuSynapticsMstFirmware {
13
  FuFirmware parent_instance;
14
  guint16 board_id;
15
  FuSynapticsMstFamily family;
16
};
17
18
345
G_DEFINE_TYPE(FuSynapticsMstFirmware, fu_synaptics_mst_firmware, FU_TYPE_FIRMWARE)
19
345
20
345
#define ADDR_CUSTOMER_ID_CARRERA 0x620E
21
9
#define ADDR_CUSTOMER_ID_CAYENNE 0x20E
22
44
#define ADDR_CUSTOMER_ID_TESLA   0x10E
23
157
#define ADDR_CONFIG_CARRERA  0x6200
24
157
#define ADDR_CONFIG_CAYENNE  0x200
25
157
#define ADDR_CONFIG_TESLA  0x100
26
27
guint16
28
fu_synaptics_mst_firmware_get_board_id(FuSynapticsMstFirmware *self)
29
0
{
30
0
  g_return_val_if_fail(FU_IS_SYNAPTICS_MST_FIRMWARE(self), 0);
31
0
  return self->board_id;
32
0
}
33
34
void
35
fu_synaptics_mst_firmware_set_family(FuSynapticsMstFirmware *self, FuSynapticsMstFamily family)
36
0
{
37
0
  g_return_if_fail(FU_IS_SYNAPTICS_MST_FIRMWARE(self));
38
0
  self->family = family;
39
0
}
40
41
static void
42
fu_synaptics_mst_firmware_export(FuFirmware *firmware,
43
         FuFirmwareExportFlags flags,
44
         XbBuilderNode *bn)
45
0
{
46
0
  FuSynapticsMstFirmware *self = FU_SYNAPTICS_MST_FIRMWARE(firmware);
47
0
  fu_xmlb_builder_insert_kx(bn, "board_id", self->board_id);
48
0
  fu_xmlb_builder_insert_kv(bn, "family", fu_synaptics_mst_family_to_string(self->family));
49
0
}
50
51
static gboolean
52
fu_synaptics_mst_firmware_detect_family(FuSynapticsMstFirmware *self,
53
          GInputStream *stream,
54
          gsize offset,
55
          GError **error)
56
157
{
57
157
  guint16 addrs[] = {ADDR_CONFIG_TESLA, ADDR_CONFIG_CAYENNE, ADDR_CONFIG_CARRERA};
58
310
  for (guint i = 0; i < G_N_ELEMENTS(addrs); i++) {
59
286
    g_autoptr(FuStructSynapticsFirmwareConfig) st = NULL;
60
286
    st = fu_struct_synaptics_firmware_config_parse_stream(stream,
61
286
                      offset + addrs[i],
62
286
                      error);
63
286
    if (st == NULL)
64
66
      return FALSE;
65
220
    if ((fu_struct_synaptics_firmware_config_get_magic1(st) & 0x80) &&
66
101
        (fu_struct_synaptics_firmware_config_get_magic2(st) & 0x80)) {
67
67
      self->family = fu_struct_synaptics_firmware_config_get_version(st) >> 4;
68
67
      return TRUE;
69
67
    }
70
220
  }
71
24
  g_set_error_literal(error,
72
24
          FWUPD_ERROR,
73
24
          FWUPD_ERROR_NOT_SUPPORTED,
74
24
          "unable to autodetect chip family");
75
24
  return FALSE;
76
157
}
77
78
static gboolean
79
fu_synaptics_mst_firmware_parse(FuFirmware *firmware,
80
        GInputStream *stream,
81
        FuFirmwareParseFlags flags,
82
        GError **error)
83
157
{
84
157
  FuSynapticsMstFirmware *self = FU_SYNAPTICS_MST_FIRMWARE(firmware);
85
157
  guint16 addr;
86
87
  /* if device family not specified by caller, try to get from firmware file */
88
157
  if (self->family == FU_SYNAPTICS_MST_FAMILY_UNKNOWN) {
89
157
    if (!fu_synaptics_mst_firmware_detect_family(self, stream, 0x0, error))
90
90
      return FALSE;
91
157
  }
92
93
67
  switch (self->family) {
94
17
  case FU_SYNAPTICS_MST_FAMILY_TESLA:
95
21
  case FU_SYNAPTICS_MST_FAMILY_LEAF:
96
24
  case FU_SYNAPTICS_MST_FAMILY_PANAMERA:
97
24
    addr = ADDR_CUSTOMER_ID_TESLA;
98
24
    break;
99
3
  case FU_SYNAPTICS_MST_FAMILY_CAYENNE:
100
5
  case FU_SYNAPTICS_MST_FAMILY_SPYDER:
101
5
    addr = ADDR_CUSTOMER_ID_CAYENNE;
102
5
    break;
103
14
  case FU_SYNAPTICS_MST_FAMILY_CARRERA:
104
14
    addr = ADDR_CUSTOMER_ID_CARRERA;
105
14
    break;
106
24
  default:
107
24
    g_set_error(error,
108
24
          FWUPD_ERROR,
109
24
          FWUPD_ERROR_NOT_SUPPORTED,
110
24
          "unsupported chip family %s",
111
24
          fu_synaptics_mst_family_to_string(self->family));
112
24
    return FALSE;
113
67
  }
114
43
  if (!fu_input_stream_read_u16(stream, addr, &self->board_id, G_BIG_ENDIAN, error))
115
12
    return FALSE;
116
117
  /* success */
118
31
  return TRUE;
119
43
}
120
121
static GByteArray *
122
fu_synaptics_mst_firmware_write(FuFirmware *firmware, GError **error)
123
31
{
124
31
  FuSynapticsMstFirmware *self = FU_SYNAPTICS_MST_FIRMWARE(firmware);
125
31
  g_autoptr(GByteArray) buf = g_byte_array_new();
126
31
  g_autoptr(GBytes) blob = NULL;
127
31
  guint16 addr;
128
129
31
  switch (self->family) {
130
15
  case FU_SYNAPTICS_MST_FAMILY_TESLA:
131
19
  case FU_SYNAPTICS_MST_FAMILY_LEAF:
132
20
  case FU_SYNAPTICS_MST_FAMILY_PANAMERA:
133
20
    addr = ADDR_CUSTOMER_ID_TESLA;
134
20
    break;
135
3
  case FU_SYNAPTICS_MST_FAMILY_CAYENNE:
136
4
  case FU_SYNAPTICS_MST_FAMILY_SPYDER:
137
4
    addr = ADDR_CUSTOMER_ID_CAYENNE;
138
4
    break;
139
7
  case FU_SYNAPTICS_MST_FAMILY_CARRERA:
140
7
    addr = ADDR_CUSTOMER_ID_CARRERA;
141
7
    break;
142
0
  default:
143
0
    g_set_error_literal(error,
144
0
            FWUPD_ERROR,
145
0
            FWUPD_ERROR_NOT_SUPPORTED,
146
0
            "unsupported chip family");
147
0
    return NULL;
148
31
  }
149
  /* assumed header */
150
31
  fu_byte_array_set_size(buf, addr + sizeof(guint16), 0x00);
151
31
  if (!fu_memwrite_uint16_safe(buf->data,
152
31
             buf->len,
153
31
             addr,
154
31
             fu_firmware_get_idx(firmware),
155
31
             G_BIG_ENDIAN,
156
31
             error))
157
0
    return NULL;
158
159
  /* payload */
160
31
  blob = fu_firmware_get_bytes_with_patches(firmware, error);
161
31
  if (blob == NULL)
162
31
    return NULL;
163
0
  fu_byte_array_append_bytes(buf, blob);
164
165
  /* success */
166
0
  return g_steal_pointer(&buf);
167
31
}
168
169
static gboolean
170
fu_synaptics_mst_firmware_build(FuFirmware *firmware, XbNode *n, GError **error)
171
0
{
172
0
  FuSynapticsMstFirmware *self = FU_SYNAPTICS_MST_FIRMWARE(firmware);
173
0
  guint64 tmp;
174
175
  /* optional properties */
176
0
  tmp = xb_node_query_text_as_uint(n, "board_id", NULL);
177
0
  if (tmp != G_MAXUINT64)
178
0
    self->board_id = tmp;
179
0
  tmp = xb_node_query_text_as_uint(n, "family", NULL);
180
0
  if (tmp != G_MAXUINT64)
181
0
    self->family = tmp;
182
183
  /* success */
184
0
  return TRUE;
185
0
}
186
187
static void
188
fu_synaptics_mst_firmware_init(FuSynapticsMstFirmware *self)
189
157
{
190
157
  self->family = FU_SYNAPTICS_MST_FAMILY_UNKNOWN;
191
157
  fu_firmware_add_flag(FU_FIRMWARE(self), FU_FIRMWARE_FLAG_NO_AUTO_DETECTION);
192
157
}
193
194
static void
195
fu_synaptics_mst_firmware_class_init(FuSynapticsMstFirmwareClass *klass)
196
1
{
197
1
  FuFirmwareClass *firmware_class = FU_FIRMWARE_CLASS(klass);
198
1
  firmware_class->parse = fu_synaptics_mst_firmware_parse;
199
1
  firmware_class->export = fu_synaptics_mst_firmware_export;
200
1
  firmware_class->write = fu_synaptics_mst_firmware_write;
201
1
  firmware_class->build = fu_synaptics_mst_firmware_build;
202
1
}
203
204
FuFirmware *
205
fu_synaptics_mst_firmware_new(void)
206
0
{
207
0
  return FU_FIRMWARE(g_object_new(FU_TYPE_SYNAPTICS_MST_FIRMWARE, NULL));
208
0
}