0
|
1 |
/*
|
|
2 |
* Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
* All rights reserved.
|
|
4 |
* This component and the accompanying materials are made available
|
|
5 |
* under the terms of the License "Eclipse Public License v1.0"
|
|
6 |
* which accompanies this distribution, and is available
|
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
8 |
*
|
|
9 |
* Initial Contributors:
|
|
10 |
* Nokia Corporation - initial contribution.
|
|
11 |
*
|
|
12 |
* Contributors:
|
|
13 |
*
|
|
14 |
* Description:
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
#ifndef __FUNCTION_INL__
|
|
20 |
#define __FUNCTION_INL__
|
|
21 |
|
|
22 |
// ======== TSDIOFunctionCaps ========
|
|
23 |
|
|
24 |
TSDIOFunctionCaps::TSDIOFunctionCaps()
|
|
25 |
/**
|
|
26 |
Constructs a TSDIOFunctionCaps object
|
|
27 |
*/
|
|
28 |
{
|
|
29 |
memclr(this, sizeof(TSDIOFunctionCaps));
|
|
30 |
}
|
|
31 |
|
|
32 |
|
|
33 |
|
|
34 |
// ======== TSDIOFunction ========
|
|
35 |
|
|
36 |
inline const TSDIOFunctionCaps& TSDIOFunction::Capabilities() const
|
|
37 |
/**
|
|
38 |
@publishedPartner
|
|
39 |
@released
|
|
40 |
|
|
41 |
Returns information about the basic capabilities of the function (function number, function type etc.).
|
|
42 |
|
|
43 |
This generally contains the information obtained from the FBR and common CIS during initialisation,
|
|
44 |
and may be used by the client to verify the basic suitability of the function during initialisation.
|
|
45 |
|
|
46 |
@return A reference to the TSDIOFunctionCaps containing the capabilities of the function.
|
|
47 |
|
|
48 |
@see TSDIOFunctionCaps
|
|
49 |
*/
|
|
50 |
{ return(iCapabilities); }
|
|
51 |
|
|
52 |
|
|
53 |
|
|
54 |
inline DSDIORegisterInterface* TSDIOFunction::RegisterInterface(DBase* aClientHandle) const
|
|
55 |
/**
|
|
56 |
@publishedPartner
|
|
57 |
@released
|
|
58 |
|
|
59 |
Returns a pointer to an instance of a DSDIORegisterInterface class
|
|
60 |
that may be used bythe client to talk to the Function Specific Registers.
|
|
61 |
|
|
62 |
@param aClientHandle The ID of the client (as registered using RegisterClient)
|
|
63 |
@return a pointer to the DSDIORegisterInterface associated with this function
|
|
64 |
|
|
65 |
@see TSDIOFunction::RegisterClient
|
|
66 |
*/
|
|
67 |
{
|
|
68 |
if(aClientHandle != NULL && (aClientHandle == iClientHandle))
|
|
69 |
return(iRegisterInterfaceP);
|
|
70 |
return(NULL);
|
|
71 |
}
|
|
72 |
|
|
73 |
|
|
74 |
|
|
75 |
inline TSDIOInterrupt& TSDIOFunction::Interrupt()
|
|
76 |
/**
|
|
77 |
@publishedPartner
|
|
78 |
@released
|
|
79 |
|
|
80 |
Returns a reference to the TSDIOInterrupt class associated with the function
|
|
81 |
that may be used bythe client to talk to the Function Specific Registers.
|
|
82 |
|
|
83 |
@return a reference to the interrupt class associated with this function
|
|
84 |
*/
|
|
85 |
{ return iInterrupt; };
|
|
86 |
|
|
87 |
|
|
88 |
|
|
89 |
inline TUint TSDIOFunction::CisPtr() const
|
|
90 |
/**
|
|
91 |
@publishedPartner
|
|
92 |
@released
|
|
93 |
|
|
94 |
Returns the address of the Function CIS
|
|
95 |
@return The address of the Function CIS
|
|
96 |
*/
|
|
97 |
{ return(iCisPtr); }
|
|
98 |
|
|
99 |
|
|
100 |
|
|
101 |
inline TUint TSDIOFunction::CsaPtr() const
|
|
102 |
/**
|
|
103 |
@publishedPartner
|
|
104 |
@released
|
|
105 |
|
|
106 |
Returns the address of the Function CSA
|
|
107 |
@return The address of the Function CSA
|
|
108 |
*/
|
|
109 |
{ return(iCsaPtr); }
|
|
110 |
|
|
111 |
|
|
112 |
|
|
113 |
inline TUint8 TSDIOFunction::FunctionNumber() const
|
|
114 |
/**
|
|
115 |
@publishedPartner
|
|
116 |
@released
|
|
117 |
|
|
118 |
Returns the number of the IO Function
|
|
119 |
@return The number of the IO Function
|
|
120 |
*/
|
|
121 |
{ return(iFunctionNumber); }
|
|
122 |
|
|
123 |
|
|
124 |
#endif // #ifndef __FUNCTION_INL__
|
|
125 |
|