xref: /freebsd/sys/dev/pms/RefTisa/discovery/api/tddmapi.h (revision 2ff63af9b88c7413b7d71715b5532625752a248e)
1*4e1bc9a0SAchim Leubner /*******************************************************************************
2*4e1bc9a0SAchim Leubner *Copyright (c) 2014 PMC-Sierra, Inc.  All rights reserved.
3*4e1bc9a0SAchim Leubner *
4*4e1bc9a0SAchim Leubner *Redistribution and use in source and binary forms, with or without modification, are permitted provided
5*4e1bc9a0SAchim Leubner *that the following conditions are met:
6*4e1bc9a0SAchim Leubner *1. Redistributions of source code must retain the above copyright notice, this list of conditions and the
7*4e1bc9a0SAchim Leubner *following disclaimer.
8*4e1bc9a0SAchim Leubner *2. Redistributions in binary form must reproduce the above copyright notice,
9*4e1bc9a0SAchim Leubner *this list of conditions and the following disclaimer in the documentation and/or other materials provided
10*4e1bc9a0SAchim Leubner *with the distribution.
11*4e1bc9a0SAchim Leubner *
12*4e1bc9a0SAchim Leubner *THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED
13*4e1bc9a0SAchim Leubner *WARRANTIES,INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
14*4e1bc9a0SAchim Leubner *FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
15*4e1bc9a0SAchim Leubner *FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
16*4e1bc9a0SAchim Leubner *NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
17*4e1bc9a0SAchim Leubner *BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
18*4e1bc9a0SAchim Leubner *LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
19*4e1bc9a0SAchim Leubner *SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
20*4e1bc9a0SAchim Leubner *
21*4e1bc9a0SAchim Leubner *
22*4e1bc9a0SAchim Leubner ********************************************************************************/
23*4e1bc9a0SAchim Leubner /********************************************************************************
24*4e1bc9a0SAchim Leubner *   tmdmapi.h
25*4e1bc9a0SAchim Leubner *
26*4e1bc9a0SAchim Leubner *   Abstract:   This module contains function prototype of the Discovery
27*4e1bc9a0SAchim Leubner *               Module (DM) API callback for initiator.
28*4e1bc9a0SAchim Leubner *******************************************************************************/
29*4e1bc9a0SAchim Leubner 
30*4e1bc9a0SAchim Leubner #ifndef TDDMAPI_H
31*4e1bc9a0SAchim Leubner 
32*4e1bc9a0SAchim Leubner #define TDDMAPI_H
33*4e1bc9a0SAchim Leubner 
34*4e1bc9a0SAchim Leubner osGLOBAL void tddmCacheFlush(
35*4e1bc9a0SAchim Leubner 				dmRoot_t 	*dmRoot,
36*4e1bc9a0SAchim Leubner 				void 		*tdMemHandle,
37*4e1bc9a0SAchim Leubner 				void 		*virtPtr,
38*4e1bc9a0SAchim Leubner 				bit32 		length
39*4e1bc9a0SAchim Leubner 				);
40*4e1bc9a0SAchim Leubner 
41*4e1bc9a0SAchim Leubner osGLOBAL void tddmCacheInvalidate(
42*4e1bc9a0SAchim Leubner 				dmRoot_t 	*dmRoot,
43*4e1bc9a0SAchim Leubner 				void 		*tdMemHandle,
44*4e1bc9a0SAchim Leubner 				void 		*virtPtr,
45*4e1bc9a0SAchim Leubner 				bit32 		length
46*4e1bc9a0SAchim Leubner 				);
47*4e1bc9a0SAchim Leubner 
48*4e1bc9a0SAchim Leubner osGLOBAL void tddmCachePreFlush(
49*4e1bc9a0SAchim Leubner 				dmRoot_t 	*dmRoot,
50*4e1bc9a0SAchim Leubner 				void 		*tdMemHandle,
51*4e1bc9a0SAchim Leubner 				void 		*virtPtr,
52*4e1bc9a0SAchim Leubner 				bit32 		length
53*4e1bc9a0SAchim Leubner 				);
54*4e1bc9a0SAchim Leubner 
55*4e1bc9a0SAchim Leubner osGLOBAL void tddmDiscoverCB(
56*4e1bc9a0SAchim Leubner 				dmRoot_t 		*dmRoot,
57*4e1bc9a0SAchim Leubner 				dmPortContext_t		*dmPortContext,
58*4e1bc9a0SAchim Leubner 				bit32			eventStatus
59*4e1bc9a0SAchim Leubner 				);
60*4e1bc9a0SAchim Leubner 
61*4e1bc9a0SAchim Leubner osGLOBAL void tddmQueryDiscoveryCB(
62*4e1bc9a0SAchim Leubner 				dmRoot_t 		*dmRoot,
63*4e1bc9a0SAchim Leubner 				dmPortContext_t		*dmPortContext,
64*4e1bc9a0SAchim Leubner 				bit32          		discType,
65*4e1bc9a0SAchim Leubner 				bit32			discState
66*4e1bc9a0SAchim Leubner 				);
67*4e1bc9a0SAchim Leubner 
68*4e1bc9a0SAchim Leubner osGLOBAL void tddmReportDevice(
69*4e1bc9a0SAchim Leubner 				dmRoot_t 		*dmRoot,
70*4e1bc9a0SAchim Leubner 				dmPortContext_t		*dmPortContext,
71*4e1bc9a0SAchim Leubner 				dmDeviceInfo_t		*dmDeviceInfo,
72*4e1bc9a0SAchim Leubner                                 dmDeviceInfo_t		*dmExpDeviceInfo,
73*4e1bc9a0SAchim Leubner 				bit32                   flag
74*4e1bc9a0SAchim Leubner 				);
75*4e1bc9a0SAchim Leubner 
76*4e1bc9a0SAchim Leubner osGLOBAL bit8 tddmSATADeviceTypeDecode(bit8 * pSignature);
77*4e1bc9a0SAchim Leubner 
78*4e1bc9a0SAchim Leubner osGLOBAL void tddmSingleThreadedEnter(
79*4e1bc9a0SAchim Leubner 				       dmRoot_t 		*dmRoot,
80*4e1bc9a0SAchim Leubner 				       bit32    		syncLockId
81*4e1bc9a0SAchim Leubner 				      );
82*4e1bc9a0SAchim Leubner 
83*4e1bc9a0SAchim Leubner osGLOBAL void tddmSingleThreadedLeave(
84*4e1bc9a0SAchim Leubner 				       dmRoot_t 		*dmRoot,
85*4e1bc9a0SAchim Leubner 				       bit32    		syncLockId
86*4e1bc9a0SAchim Leubner 				      );
87*4e1bc9a0SAchim Leubner osGLOBAL bit32 tddmGetTransportParam(
88*4e1bc9a0SAchim Leubner                         dmRoot_t    *dmRoot,
89*4e1bc9a0SAchim Leubner                         char        *key,
90*4e1bc9a0SAchim Leubner                         char        *subkey1,
91*4e1bc9a0SAchim Leubner                         char        *subkey2,
92*4e1bc9a0SAchim Leubner                         char        *subkey3,
93*4e1bc9a0SAchim Leubner                         char        *subkey4,
94*4e1bc9a0SAchim Leubner                         char        *subkey5,
95*4e1bc9a0SAchim Leubner                         char        *valueName,
96*4e1bc9a0SAchim Leubner                         char        *buffer,
97*4e1bc9a0SAchim Leubner                         bit32       bufferLen,
98*4e1bc9a0SAchim Leubner                         bit32       *lenReceived
99*4e1bc9a0SAchim Leubner                         );
100*4e1bc9a0SAchim Leubner osGLOBAL bit32
101*4e1bc9a0SAchim Leubner tddmRotateQnumber(
102*4e1bc9a0SAchim Leubner                   dmRoot_t          *dmRoot,
103*4e1bc9a0SAchim Leubner                   agsaDevHandle_t   *agDevHandle
104*4e1bc9a0SAchim Leubner                  );
105*4e1bc9a0SAchim Leubner #ifndef tddmLogDebugString
106*4e1bc9a0SAchim Leubner GLOBAL void tddmLogDebugString(
107*4e1bc9a0SAchim Leubner                          dmRoot_t     *dmRoot,
108*4e1bc9a0SAchim Leubner                          bit32        level,
109*4e1bc9a0SAchim Leubner                          char         *string,
110*4e1bc9a0SAchim Leubner                          void         *ptr1,
111*4e1bc9a0SAchim Leubner                          void         *ptr2,
112*4e1bc9a0SAchim Leubner                          bit32        value1,
113*4e1bc9a0SAchim Leubner                          bit32        value2
114*4e1bc9a0SAchim Leubner                          );
115*4e1bc9a0SAchim Leubner #endif
116*4e1bc9a0SAchim Leubner 
117*4e1bc9a0SAchim Leubner 
118*4e1bc9a0SAchim Leubner #endif  /* TDDMAPI_H */
119