source: mainline/uspace/lib/drv/include/ahci_iface.h@ 95658c9

ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 95658c9 was c8ea6eca, checked in by Jakub Jermar <jakub@…>, 7 years ago

Improve doxygen documentation

  • Property mode set to 100644
File size: 2.4 KB
Line 
1/*
2 * Copyright (c) 2012 Petr Jerman
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libdrv
30 * @{
31 */
32/** @file
33 * @brief AHCI interface definition.
34 */
35
36#ifndef LIBDRV_AHCI_IFACE_H_
37#define LIBDRV_AHCI_IFACE_H_
38
39#include "ddf/driver.h"
40#include <async.h>
41
42extern async_sess_t *ahci_get_sess(devman_handle_t, char **);
43
44extern errno_t ahci_get_sata_device_name(async_sess_t *, size_t, char *);
45extern errno_t ahci_get_num_blocks(async_sess_t *, uint64_t *);
46extern errno_t ahci_get_block_size(async_sess_t *, size_t *);
47extern errno_t ahci_read_blocks(async_sess_t *, uint64_t, size_t, void *);
48extern errno_t ahci_write_blocks(async_sess_t *, uint64_t, size_t, void *);
49
50/** AHCI device communication interface. */
51typedef struct {
52 errno_t (*get_sata_device_name)(ddf_fun_t *, size_t, char *);
53 errno_t (*get_num_blocks)(ddf_fun_t *, uint64_t *);
54 errno_t (*get_block_size)(ddf_fun_t *, size_t *);
55 errno_t (*read_blocks)(ddf_fun_t *, uint64_t, size_t, void *);
56 errno_t (*write_blocks)(ddf_fun_t *, uint64_t, size_t, void *);
57} ahci_iface_t;
58
59#endif
60
61/**
62 * @}
63 */
Note: See TracBrowser for help on using the repository browser.