blob: bc346f9a01c1d81130f81e3b2bed46928db496fc (
plain)
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
|
/*
* io.h
*
* DSP-BIOS Bridge driver support functions for TI OMAP processors.
*
* The io module manages IO between CHNL and msg_ctrl.
*
* Copyright (C) 2005-2006 Texas Instruments, Inc.
*
* This package is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
* WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
*/
#ifndef IO_
#define IO_
#include <dspbridge/cfgdefs.h>
#include <dspbridge/devdefs.h>
#include <dspbridge/iodefs.h>
/*
* ======== io_create ========
* Purpose:
* Create an IO manager object, responsible for managing IO between
* CHNL and msg_ctrl.
* Parameters:
* channel_mgr: Location to store a channel manager object on
* output.
* hdev_obj: Handle to a device object.
* mgr_attrts: IO manager attributes.
* mgr_attrts->birq: I/O IRQ number.
* mgr_attrts->irq_shared: TRUE if the IRQ is shareable.
* mgr_attrts->word_size: DSP Word size in equivalent PC bytes..
* Returns:
* 0: Success;
* -ENOMEM: Insufficient memory for requested resources.
* -EIO: Unable to plug channel ISR for configured IRQ.
* -EINVAL: Invalid DSP word size (must be > 0).
* Invalid base address for DSP communications.
* Requires:
* io_init(void) called.
* io_man != NULL.
* mgr_attrts != NULL.
* Ensures:
*/
extern int io_create(struct io_mgr **io_man,
struct dev_object *hdev_obj,
const struct io_attrs *mgr_attrts);
/*
* ======== io_destroy ========
* Purpose:
* Destroy the IO manager.
* Parameters:
* hio_mgr: IOmanager object.
* Returns:
* 0: Success.
* -EFAULT: hio_mgr was invalid.
* Requires:
* io_init(void) called.
* Ensures:
*/
extern int io_destroy(struct io_mgr *hio_mgr);
/*
* ======== io_exit ========
* Purpose:
* Discontinue usage of the IO module.
* Parameters:
* Returns:
* Requires:
* io_init(void) previously called.
* Ensures:
* Resources, if any acquired in io_init(void), are freed when the last
* client of IO calls io_exit(void).
*/
extern void io_exit(void);
/*
* ======== io_init ========
* Purpose:
* Initialize the IO module's private state.
* Parameters:
* Returns:
* TRUE if initialized; FALSE if error occurred.
* Requires:
* Ensures:
* A requirement for each of the other public CHNL functions.
*/
extern bool io_init(void);
/*
* ======== io_on_loaded ========
* Purpose:
* Called when a program is loaded so IO manager can update its
* internal state.
* Parameters:
* hio_mgr: IOmanager object.
* Returns:
* 0: Success.
* -EFAULT: hio_mgr was invalid.
* Requires:
* io_init(void) called.
* Ensures:
*/
extern int io_on_loaded(struct io_mgr *hio_mgr);
#endif /* CHNL_ */
|
