source: mainline/uspace/lib/drv/include/usbhc_iface.h@ 7f9df7b9

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 7f9df7b9 was b7fd2a0, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 8 years ago

Use errno_t in all uspace and kernel code.

Change type of every variable, parameter and return value that holds an
<errno.h> constant to either errno_t (the usual case), or sys_errno_t
(some places in kernel). This is for the purpose of self-documentation,
as well as for type-checking with a bit of type definition hackery.

Although this is a massive commit, it is a simple text replacement, and thus
is very easy to verify. Simply do the following:

`
git checkout <this commit's hash>
git reset HEAD
git add .
tools/srepl '\berrno_t\b' int
git add .
tools/srepl '\bsys_errno_t\b' sysarg_t
git reset
git diff
`

While this doesn't ensure that the replacements are correct, it does ensure
that the commit doesn't do anything except those replacements. Since errno_t
is typedef'd to int in the usual case (and sys_errno_t to sysarg_t), even if
incorrect, this commit cannot change behavior.
  • Property mode set to 100644
File size: 2.5 KB
Line 
1/*
2 * Copyright (c) 2010 Vojtech Horky
3 * Copyright (c) 2011 Jan Vesely
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * - Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * - The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/** @addtogroup libdrv
31 * @addtogroup usb
32 * @{
33 */
34
35/** @file
36 * @brief USB host controller interface definition.
37 */
38
39#ifndef LIBDRV_USBHC_IFACE_H_
40#define LIBDRV_USBHC_IFACE_H_
41
42#include "ddf/driver.h"
43#include <usb_iface.h>
44#include <stdbool.h>
45
46extern errno_t usbhc_read(async_exch_t *, usb_address_t, usb_endpoint_t,
47 uint64_t, void *, size_t, size_t *);
48extern errno_t usbhc_write(async_exch_t *, usb_address_t, usb_endpoint_t,
49 uint64_t, const void *, size_t);
50
51/** Callback for outgoing transfer. */
52typedef void (*usbhc_iface_transfer_out_callback_t)(errno_t, void *);
53
54/** Callback for incoming transfer. */
55typedef void (*usbhc_iface_transfer_in_callback_t)(errno_t, size_t, void *);
56
57/** USB host controller communication interface. */
58typedef struct {
59 errno_t (*read)(ddf_fun_t *, usb_target_t, uint64_t, uint8_t *, size_t,
60 usbhc_iface_transfer_in_callback_t, void *);
61 errno_t (*write)(ddf_fun_t *, usb_target_t, uint64_t, const uint8_t *,
62 size_t, usbhc_iface_transfer_out_callback_t, void *);
63} usbhc_iface_t;
64
65
66#endif
67/**
68 * @}
69 */
Note: See TracBrowser for help on using the repository browser.