blackmagic-sys 0.1.0

Bindings to Blackmagic-debug host functions
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

/*
 * This file is part of the Black Magic Debug project.
 *
 * Copyright (C) 2022 1BitSquared <info@1bitsquared.com>
 * Written by Rachel Mant <git@dragonmux.network>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <stdlib.h>
#include "probe_info.h"
#include "general.h"

probe_info_s *probe_info_add_by_serial(probe_info_s *const list, const probe_type_e type, const char *const mfr,
	const char *const product, const char *const serial, const char *const version)
{
	return probe_info_add_by_id(list, type, NULL, 0, 0, mfr, product, serial, version);
}

probe_info_s *probe_info_add_by_id(probe_info_s *const list, const probe_type_e type, libusb_device *device,
	uint16_t vid, uint16_t pid, const char *const mfr, const char *const product, const char *const serial,
	const char *const version)
{
#if HOSTED_BMP_ONLY == 1
	(void)device;
#endif
	probe_info_s *probe_info = malloc(sizeof(*probe_info));
	if (!probe_info) {
		DEBUG_INFO("Fatal: Failed to allocate memory for a probe info structure\n");
		return NULL;
	}

	probe_info->type = type;
	probe_info->vid = vid;
	probe_info->pid = pid;
#if HOSTED_BMP_ONLY == 0
	if (device != NULL)
		probe_info->device = libusb_ref_device(device);
	else
		probe_info->device = NULL;
#endif
	probe_info->manufacturer = mfr;
	probe_info->product = product;
	probe_info->serial = serial;
	probe_info->version = version;

	probe_info->next = list;
	return probe_info;
}

size_t probe_info_count(const probe_info_s *const list)
{
	size_t probes = 0;
	for (const probe_info_s *probe_info = list; probe_info; probe_info = probe_info->next)
		++probes;
	return probes;
}

void probe_info_free(probe_info_s *const probe_info)
{
#if HOSTED_BMP_ONLY == 0
	if (probe_info->device)
		libusb_unref_device(probe_info->device);
#endif
	free((void *)probe_info->manufacturer);
	free((void *)probe_info->product);
	free((void *)probe_info->serial);
	free((void *)probe_info->version);
	free(probe_info);
}

void probe_info_list_free(const probe_info_s *list)
{
	while (list) {
		probe_info_s *probe_info = (probe_info_s *)list;
		list = probe_info->next;
		probe_info_free(probe_info);
	}
}

const probe_info_s *probe_info_correct_order(probe_info_s *list)
{
	probe_info_s *list_head = NULL;
	while (list) {
		probe_info_s *probe_info = list->next;
		list->next = list_head;
		list_head = list;
		list = probe_info;
	}
	return list_head;
}

const probe_info_s *probe_info_filter(const probe_info_s *const list, const char *const serial, const size_t position)
{
	const probe_info_s *probe_info = list;
	for (size_t probe = 1; probe_info; probe_info = probe_info->next, ++probe) {
		if ((serial && strstr(probe_info->serial, serial)) || (position && probe == position))
			return probe_info;
	}
	return NULL;
}

static void copy_string(const char *const from, char *const to, const size_t max_len)
{
	const size_t length = MIN(strlen(from), max_len - 1U);
	memcpy(to, from, length);
	to[length] = '\0';
}

void probe_info_to_bmda_probe(const probe_info_s *const probe, bmda_probe_s *info)
{
	info->type = probe->type;
#if HOSTED_BMP_ONLY != 1
	info->pid = probe->pid;
	info->vid = probe->vid;
#endif
	copy_string(probe->serial, info->serial, sizeof(info->serial));
	copy_string(probe->version, info->version, sizeof(info->version));
	copy_string(probe->product, info->product, sizeof(info->product));
	copy_string(probe->manufacturer, info->manufacturer, sizeof(info->manufacturer));

#if HOSTED_BMP_ONLY == 0
	if (probe->device)
		info->libusb_dev = libusb_ref_device(probe->device);
#endif
}