source: trunk/kernel/devices/dev_iob.h @ 168

Last change on this file since 168 was 14, checked in by alain, 8 years ago

Bugs fix.
File size: 5.5 KB
Line 
1/*
2 * dev_iob.h - IOB (bridge to external I/O) generic device API.
3 *
4 * Authors   Alain Greiner  (2016)
5 *
6 * Copyright (c) UPMC Sorbonne Universites
7 *
8 * This file is part of ALMOS-MKH.
9 *
10 * ALMOS-MKH is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2.0 of the License.
13 *
14 * ALMOS-MKH is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTIOBLAR PURPOSE.  See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with ALMOS-MKH; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24#ifndef _DEV_IOB_H_
25#define _DEV_IOB_H_
26
27#include <kernel_config.h>
28#include <hal_types.h>
29#include <spinlock.h>
30
31/*****************************************************************************************
32 *     Generic IOB (bridge to external IO peripherals) definition.
33 *
34 * The IOB device is used to access external peripherals. It implements an IO-MMU service
35 * for DMA transactions launched by DMA capable external peripherals.
36 * This IOB peripheral is acting as a dynamically configurable bridge, used for others
37 * I/O operations. Therefore, ALMOS-MKH does not use the IOB device waiting queue,
38 * and calls directly the IOB driver blocking functions, using the device lock to
39 * get exclusive access to the IOB bridge internal state.
40 ****************************************************************************************/
41 
42/****  Forward declarations  ****/
43
44struct chdev_s;
45
46/*****************************************************************************************
47 * This enum defines the various implementations of the IOB generic device.
48 * This array must be kept consistent with the define in arch_info.h file
49 ****************************************************************************************/
50
51enum iob_impl_e
52{
53    IMPL_IOB_TSR =   0,         /* vci_iob component used in TSAR                       */
54    IMPL_IOB_I86 =   1,         /* TBD                                                  */
55}
56iob_impl_t;
57
58/*****************************************************************************************
59 * This function initializes the IOB device descriptor with IOMMU disabled.
60 *****************************************************************************************
61 * @ chdev      :  pointer on IOB chdev descriptor.
62 ****************************************************************************************/
63void dev_iob_init( struct chdev_s * chdev );
64
65/*****************************************************************************************
66 * This function activates the IOMMU for the IOB device identified by its
67 * extended pointer.
68 *****************************************************************************************
69 * @ dev_xp   : extended pointer on IOB device descriptor.
70 ****************************************************************************************/
71void dev_iob_iommu_enable( xptr_t dev_xp );
72
73/*****************************************************************************************
74 * This function desactivates the IO-MMU for the IOB device identified by its
75 * extended pointer.
76 *****************************************************************************************
77 * @ dev_xp   : extended pointer on IOB device descriptor.
78 ****************************************************************************************/
79void dev_iob_iommu_disable( xptr_t dev_xp );
80
81/*****************************************************************************************
82 * This function set a new value in the IO-MMU PTPR register.
83 *****************************************************************************************
84 * @ dev_xp   : extended pointer on IOB device descriptor.
85 * @ wdata    : value to be written in PTPR register.
86 ****************************************************************************************/
87void dev_iob_set_ptpr( xptr_t    dev_xp,
88                       uint32_t  wdata );
89                       
90/*****************************************************************************************
91 * This function invalidates an IOMMU TLB entry identified by its vpn.
92 *****************************************************************************************
93 * @ dev_xp   : extended pointer on IOB device descriptor.
94 * @ vpn      : virtual page number in IO virtual space.
95 ****************************************************************************************/
96void dev_iob_inval_page( xptr_t  dev_xp,
97                         vpn_t   vpn );
98
99/*****************************************************************************************
100 * This function return informations relative to an error reported by the IOMMU.
101 *****************************************************************************************
102 * @ dev_xp   : extended pointer on IOB device descriptor.
103 * @ error    : [out] pointer on buffer for erro type.
104 * @ bvar     : [out] pointer on buffer for bad virtual address.
105 * @ srcid    : [out] pointer on buffer for faulty peripheral index.
106 ****************************************************************************************/
107void dev_iob_get_status( xptr_t     dev_xp,
108                         uint32_t * error,
109                         uint32_t * bvar,
110                         uint32_t * srcid );
111
112#endif  /* _DEV_IOB_H_ */
Note: See TracBrowser for help on using the repository browser.