firmware.h revision 1.3 
1/*	$NetBSD: firmware.h,v 1.3 2014/07/16 20:59:58 riastradh Exp $	*/
2
3/*-
4 * Copyright (c) 2013 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Taylor R. Campbell.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#ifndef _LINUX_FIRMWARE_H_
33#define _LINUX_FIRMWARE_H_
34
35#include <sys/types.h>
36#include <sys/device.h>
37#include <sys/kmem.h>
38#include <sys/systm.h>
39
40#include <dev/firmload.h>
41
42struct device;
43
44struct firmware {
45	firmware_handle_t	fw_h;
46	void			*data;
47	size_t			size;
48};
49
50static inline int
51request_firmware(const struct firmware **fwp, const char *image_name,
52    struct device *dev)
53{
54	struct firmware *fw;
55	int ret;
56
57	fw = kmem_alloc(sizeof(*fw), KM_SLEEP);
58
59	/* XXX errno NetBSD->Linux */
60	ret = -firmware_open(device_cfdriver(dev)->cd_name, image_name,
61	    &fw->fw_h);
62	if (ret)
63		goto fail0;
64	fw->size = firmware_get_size(fw->fw_h);
65	fw->data = firmware_malloc(fw->size);
66
67	/* XXX errno NetBSD->Linux */
68	ret = -firmware_read(fw->fw_h, 0, fw->data, fw->size);
69	if (ret)
70		goto fail1;
71
72	/* Success!  */
73	*fwp = fw;
74	return 0;
75
76fail1:	firmware_free(fw->data, fw->size);
77fail0:	KASSERT(ret);
78	kmem_free(fw, sizeof(*fw));
79	return ret;
80}
81
82static inline void
83release_firmware(const struct firmware *fw)
84{
85
86	firmware_free(fw->data, fw->size);
87	kmem_free(__UNCONST(fw), sizeof(*fw));
88}
89
90#endif  /* _LINUX_FIRMWARE_H_ */
91