2 * WINE Drivers functions
4 * Copyright 1994 Martin Ayotte
5 * Copyright 1998 Marcus Meissner
6 * Copyright 1999 Eric Pouech
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
33 #include "wine/debug.h"
35 #include "wine/exception.h"
37 WINE_DEFAULT_DEBUG_CHANNEL(driver
);
39 static CRITICAL_SECTION mmdriver_lock
;
40 static CRITICAL_SECTION_DEBUG mmdriver_lock_debug
=
43 { &mmdriver_lock_debug
.ProcessLocksList
, &mmdriver_lock_debug
.ProcessLocksList
},
44 0, 0, { (DWORD_PTR
)(__FILE__
": mmdriver_lock") }
46 static CRITICAL_SECTION mmdriver_lock
= { &mmdriver_lock_debug
, -1, 0, 0, 0, 0 };
48 static LPWINE_DRIVER lpDrvItemList
/* = NULL */;
50 static void DRIVER_Dump(const char *comment
)
55 TRACE("%s\n", comment
);
57 EnterCriticalSection( &mmdriver_lock
);
59 for (lpDrv
= lpDrvItemList
; lpDrv
!= NULL
; lpDrv
= lpDrv
->lpNextItem
)
61 TRACE("%p, magic %04lx, id %p, next %p\n", lpDrv
, lpDrv
->dwMagic
, lpDrv
->d
.d32
.dwDriverID
, lpDrv
->lpNextItem
);
64 LeaveCriticalSection( &mmdriver_lock
);
68 /**************************************************************************
69 * DRIVER_GetNumberOfModuleRefs [internal]
71 * Returns the number of open drivers which share the same module.
73 static unsigned DRIVER_GetNumberOfModuleRefs(HMODULE hModule
, WINE_DRIVER
** found
)
78 EnterCriticalSection( &mmdriver_lock
);
80 if (found
) *found
= NULL
;
81 for (lpDrv
= lpDrvItemList
; lpDrv
; lpDrv
= lpDrv
->lpNextItem
)
83 if (lpDrv
->hModule
== hModule
)
85 if (found
&& !*found
) *found
= lpDrv
;
90 LeaveCriticalSection( &mmdriver_lock
);
94 /**************************************************************************
95 * DRIVER_FindFromHDrvr [internal]
97 * From a hDrvr being 32 bits, returns the WINE internal structure.
99 LPWINE_DRIVER
DRIVER_FindFromHDrvr(HDRVR hDrvr
)
105 d
= (LPWINE_DRIVER
)hDrvr
;
106 if (d
&& d
->dwMagic
!= WINE_DI_MAGIC
) d
= NULL
;
114 if (d
) TRACE("%p -> %p, %p\n", hDrvr
, d
->lpDrvProc
, (void *)d
->dwDriverID
);
115 else TRACE("%p -> NULL\n", hDrvr
);
120 /**************************************************************************
121 * DRIVER_SendMessage [internal]
123 static inline LRESULT
DRIVER_SendMessage(LPWINE_DRIVER lpDrv
, UINT msg
,
124 LPARAM lParam1
, LPARAM lParam2
)
128 TRACE("Before call32 proc=%p drvrID=%08lx hDrv=%p wMsg=%04x p1=%08lx p2=%08lx\n",
129 lpDrv
->lpDrvProc
, lpDrv
->dwDriverID
, lpDrv
, msg
, lParam1
, lParam2
);
130 ret
= lpDrv
->lpDrvProc(lpDrv
->dwDriverID
, (HDRVR
)lpDrv
, msg
, lParam1
, lParam2
);
131 TRACE("After call32 proc=%p drvrID=%08lx hDrv=%p wMsg=%04x p1=%08lx p2=%08lx => %08lx\n",
132 lpDrv
->lpDrvProc
, lpDrv
->dwDriverID
, lpDrv
, msg
, lParam1
, lParam2
, ret
);
137 /**************************************************************************
138 * SendDriverMessage [WINMM.@]
139 * DrvSendMessage [WINMM.@]
141 LRESULT WINAPI
SendDriverMessage(HDRVR hDriver
, UINT msg
, LPARAM lParam1
,
147 TRACE("(%p, %04X, %08lX, %08lX)\n", hDriver
, msg
, lParam1
, lParam2
);
149 if ((lpDrv
= DRIVER_FindFromHDrvr(hDriver
)) != NULL
) {
150 retval
= DRIVER_SendMessage(lpDrv
, msg
, lParam1
, lParam2
);
152 WARN("Bad driver handle %p\n", hDriver
);
154 TRACE("retval = %ld\n", retval
);
159 /**************************************************************************
160 * DRIVER_RemoveFromList [internal]
162 * Generates all the logic to handle driver closure / deletion
163 * Removes a driver struct to the list of open drivers.
165 static BOOL
DRIVER_RemoveFromList(LPWINE_DRIVER lpDrv
)
167 /* last of this driver in list ? */
168 if (DRIVER_GetNumberOfModuleRefs(lpDrv
->hModule
, NULL
) == 1) {
169 DRIVER_SendMessage(lpDrv
, DRV_DISABLE
, 0L, 0L);
170 DRIVER_SendMessage(lpDrv
, DRV_FREE
, 0L, 0L);
173 EnterCriticalSection( &mmdriver_lock
);
175 if (lpDrv
->lpPrevItem
)
176 lpDrv
->lpPrevItem
->lpNextItem
= lpDrv
->lpNextItem
;
178 lpDrvItemList
= lpDrv
->lpNextItem
;
179 if (lpDrv
->lpNextItem
)
180 lpDrv
->lpNextItem
->lpPrevItem
= lpDrv
->lpPrevItem
;
181 /* trash magic number */
182 lpDrv
->dwMagic
^= 0xa5a5a5a5;
183 lpDrv
->lpDrvProc
= NULL
;
184 lpDrv
->dwDriverID
= 0;
186 LeaveCriticalSection( &mmdriver_lock
);
191 /**************************************************************************
192 * DRIVER_AddToList [internal]
194 * Adds a driver struct to the list of open drivers.
195 * Generates all the logic to handle driver creation / open.
197 static BOOL
DRIVER_AddToList(LPWINE_DRIVER lpNewDrv
, LPARAM lParam1
, LPARAM lParam2
)
199 lpNewDrv
->dwMagic
= WINE_DI_MAGIC
;
200 /* First driver to be loaded for this module, need to load correctly the module */
201 /* first of this driver in list ? */
202 if (DRIVER_GetNumberOfModuleRefs(lpNewDrv
->hModule
, NULL
) == 0) {
203 if (DRIVER_SendMessage(lpNewDrv
, DRV_LOAD
, 0L, 0L) != DRV_SUCCESS
) {
204 TRACE("DRV_LOAD failed on driver %p\n", lpNewDrv
);
207 /* returned value is not checked */
208 DRIVER_SendMessage(lpNewDrv
, DRV_ENABLE
, 0L, 0L);
211 /* Now just open a new instance of a driver on this module */
212 lpNewDrv
->dwDriverID
= DRIVER_SendMessage(lpNewDrv
, DRV_OPEN
, lParam1
, lParam2
);
214 if (lpNewDrv
->dwDriverID
== 0)
216 TRACE("DRV_OPEN failed on driver %p\n", lpNewDrv
);
220 EnterCriticalSection( &mmdriver_lock
);
222 lpNewDrv
->lpNextItem
= NULL
;
223 if (lpDrvItemList
== NULL
) {
224 lpDrvItemList
= lpNewDrv
;
225 lpNewDrv
->lpPrevItem
= NULL
;
227 LPWINE_DRIVER lpDrv
= lpDrvItemList
; /* find end of list */
228 while (lpDrv
->lpNextItem
!= NULL
)
229 lpDrv
= lpDrv
->lpNextItem
;
231 lpDrv
->lpNextItem
= lpNewDrv
;
232 lpNewDrv
->lpPrevItem
= lpDrv
;
235 LeaveCriticalSection( &mmdriver_lock
);
239 /**************************************************************************
240 * DRIVER_GetLibName [internal]
243 BOOL
DRIVER_GetLibName(LPCWSTR keyName
, LPCWSTR sectName
, LPWSTR buf
, int sz
)
248 TRACE("registry: %s, %s, %p, %d\n", debugstr_w(keyName
), debugstr_w(sectName
), buf
, sz
);
250 lRet
= RegOpenKeyExW(HKEY_LOCAL_MACHINE
, L
"Software\\Microsoft\\Windows NT\\CurrentVersion",
251 0, KEY_QUERY_VALUE
, &hKey
);
252 if (lRet
== ERROR_SUCCESS
) {
253 lRet
= RegOpenKeyExW(hKey
, sectName
, 0, KEY_QUERY_VALUE
, &hSecKey
);
254 if (lRet
== ERROR_SUCCESS
) {
256 lRet
= RegQueryValueExW(hSecKey
, keyName
, 0, 0, (void*)buf
, &bufLen
);
257 RegCloseKey( hSecKey
);
261 if (lRet
== ERROR_SUCCESS
) return TRUE
;
263 /* default to system.ini if we can't find it in the registry,
264 * to support native installations where system.ini is still used */
265 TRACE("system.ini: %s, %s, %p, %d\n", debugstr_w(keyName
), debugstr_w(sectName
), buf
, sz
);
266 return GetPrivateProfileStringW(sectName
, keyName
, L
"", buf
, sz
/ sizeof(WCHAR
), L
"SYSTEM.INI");
269 /**************************************************************************
270 * DRIVER_TryOpenDriver32 [internal]
272 * Tries to load a 32 bit driver whose DLL's (module) name is fn
274 LPWINE_DRIVER
DRIVER_TryOpenDriver32(LPCWSTR fn
, LPARAM lParam2
)
276 LPWINE_DRIVER lpDrv
= NULL
;
281 TRACE("(%s, %08lX);\n", debugstr_w(fn
), lParam2
);
283 if ((ptr
= wcschr(fn
, ' ')) != NULL
) {
285 while (*ptr
== ' ') ptr
++;
286 if (*ptr
== '\0') ptr
= NULL
;
289 lpDrv
= HeapAlloc(GetProcessHeap(), 0, sizeof(WINE_DRIVER
));
290 if (lpDrv
== NULL
) {cause
= "OOM"; goto exit
;}
292 if ((hModule
= LoadLibraryW(fn
)) == 0) {cause
= "Not a 32 bit lib"; goto exit
;}
294 lpDrv
->lpDrvProc
= (DRIVERPROC
)GetProcAddress(hModule
, "DriverProc");
295 if (lpDrv
->lpDrvProc
== NULL
) {cause
= "no DriverProc"; goto exit
;}
298 lpDrv
->hModule
= hModule
;
299 lpDrv
->dwDriverID
= 0;
301 /* Win32 installable drivers must support a two phase opening scheme:
302 * + first open with NULL as lParam2 (session instance),
303 * + then do a second open with the real non null lParam2)
305 if (DRIVER_GetNumberOfModuleRefs(lpDrv
->hModule
, NULL
) == 0 && lParam2
)
309 if (!DRIVER_AddToList(lpDrv
, (LPARAM
)ptr
, 0L))
311 cause
= "load0 failed";
314 ret
= DRIVER_TryOpenDriver32(fn
, lParam2
);
317 CloseDriver((HDRVR
)lpDrv
, 0L, 0L);
318 cause
= "load1 failed";
321 lpDrv
->dwFlags
|= WINE_GDF_SESSION
;
325 if (!DRIVER_AddToList(lpDrv
, (LPARAM
)ptr
, lParam2
))
326 {cause
= "load failed"; goto exit
;}
328 TRACE("=> %p\n", lpDrv
);
331 FreeLibrary(hModule
);
332 HeapFree(GetProcessHeap(), 0, lpDrv
);
333 TRACE("Unable to load 32 bit module %s: %s\n", debugstr_w(fn
), cause
);
337 /**************************************************************************
338 * OpenDriverA [WINMM.@]
340 * (0,1,DRV_LOAD ,0 ,0)
341 * (0,1,DRV_ENABLE,0 ,0)
342 * (0,1,DRV_OPEN ,buf[256],0)
344 HDRVR WINAPI
OpenDriverA(LPCSTR lpDriverName
, LPCSTR lpSectionName
, LPARAM lParam
)
353 len
= MultiByteToWideChar( CP_ACP
, 0, lpDriverName
, -1, NULL
, 0 );
354 dn
= HeapAlloc( GetProcessHeap(), 0, len
* sizeof(WCHAR
) );
356 MultiByteToWideChar( CP_ACP
, 0, lpDriverName
, -1, dn
, len
);
361 len
= MultiByteToWideChar( CP_ACP
, 0, lpSectionName
, -1, NULL
, 0 );
362 sn
= HeapAlloc( GetProcessHeap(), 0, len
* sizeof(WCHAR
) );
364 MultiByteToWideChar( CP_ACP
, 0, lpSectionName
, -1, sn
, len
);
367 ret
= OpenDriver(dn
, sn
, lParam
);
370 HeapFree(GetProcessHeap(), 0, dn
);
371 HeapFree(GetProcessHeap(), 0, sn
);
375 /**************************************************************************
376 * OpenDriver [WINMM.@]
379 HDRVR WINAPI
OpenDriver(LPCWSTR lpDriverName
, LPCWSTR lpSectionName
, LPARAM lParam
)
381 LPWINE_DRIVER lpDrv
= NULL
;
382 WCHAR libName
[MAX_PATH
+ 1];
383 LPCWSTR lsn
= lpSectionName
;
385 TRACE("(%s, %s, 0x%08lx);\n",
386 debugstr_w(lpDriverName
), debugstr_w(lpSectionName
), lParam
);
388 DRIVER_Dump("BEFORE:");
391 lstrcpynW(libName
, lpDriverName
, ARRAY_SIZE(libName
));
393 if ((lpDrv
= DRIVER_TryOpenDriver32(libName
, lParam
)))
397 if (DRIVER_GetLibName(lpDriverName
, lsn
, libName
, sizeof(libName
)) &&
398 (lpDrv
= DRIVER_TryOpenDriver32(libName
, lParam
)))
401 TRACE("Failed to open driver %s from system.ini file, section %s\n",
402 debugstr_w(lpDriverName
), debugstr_w(lpSectionName
));
405 TRACE("=> %p\n", lpDrv
);
407 DRIVER_Dump("AFTER:");
412 /**************************************************************************
413 * CloseDriver [WINMM.@]
416 LRESULT WINAPI
CloseDriver(HDRVR hDrvr
, LPARAM lParam1
, LPARAM lParam2
)
421 TRACE("(%p, %08lX, %08lX);\n", hDrvr
, lParam1
, lParam2
);
423 DRIVER_Dump("BEFORE:");
425 if ((lpDrv
= DRIVER_FindFromHDrvr(hDrvr
)) != NULL
)
427 LPWINE_DRIVER lpDrv0
;
429 DRIVER_SendMessage(lpDrv
, DRV_CLOSE
, lParam1
, lParam2
);
431 DRIVER_RemoveFromList(lpDrv
);
433 if (lpDrv
->dwFlags
& WINE_GDF_SESSION
)
434 FIXME("WINE_GDF_SESSION: Shouldn't happen (%p)\n", lpDrv
);
435 /* if driver has an opened session instance, we have to close it too */
436 if (DRIVER_GetNumberOfModuleRefs(lpDrv
->hModule
, &lpDrv0
) == 1 &&
437 (lpDrv0
->dwFlags
& WINE_GDF_SESSION
))
439 DRIVER_SendMessage(lpDrv0
, DRV_CLOSE
, 0, 0);
440 DRIVER_RemoveFromList(lpDrv0
);
441 FreeLibrary(lpDrv0
->hModule
);
442 HeapFree(GetProcessHeap(), 0, lpDrv0
);
444 FreeLibrary(lpDrv
->hModule
);
446 HeapFree(GetProcessHeap(), 0, lpDrv
);
451 WARN("Failed to close driver\n");
455 DRIVER_Dump("AFTER:");
460 /**************************************************************************
461 * GetDriverFlags [WINMM.@]
462 * [in] hDrvr handle to the driver
465 * 0x00000000 if hDrvr is an invalid handle
466 * 0x80000000 if hDrvr is a valid 32 bit driver
467 * 0x90000000 if hDrvr is a valid 16 bit driver
469 * native WINMM doesn't return those flags
470 * 0x80000000 for a valid 32 bit driver and that's it
471 * (I may have mixed up the two flags :-(
473 DWORD WINAPI
GetDriverFlags(HDRVR hDrvr
)
478 TRACE("(%p)\n", hDrvr
);
480 if ((lpDrv
= DRIVER_FindFromHDrvr(hDrvr
)) != NULL
) {
481 ret
= WINE_GDF_EXIST
| (lpDrv
->dwFlags
& WINE_GDF_EXTERNAL_MASK
);
486 /**************************************************************************
487 * GetDriverModuleHandle [WINMM.@]
488 * DrvGetModuleHandle [WINMM.@]
490 HMODULE WINAPI
GetDriverModuleHandle(HDRVR hDrvr
)
495 TRACE("(%p);\n", hDrvr
);
497 if ((lpDrv
= DRIVER_FindFromHDrvr(hDrvr
)) != NULL
) {
498 hModule
= lpDrv
->hModule
;
500 TRACE("=> %p\n", hModule
);
504 /**************************************************************************
505 * DefDriverProc [WINMM.@]
506 * DrvDefDriverProc [WINMM.@]
508 LRESULT WINAPI
DefDriverProc(DWORD_PTR dwDriverIdentifier
, HDRVR hDrv
,
509 UINT Msg
, LPARAM lParam1
, LPARAM lParam2
)
525 /**************************************************************************
526 * DRIVER_getCallback [internal]
528 static const char* DRIVER_getCallback(DWORD uFlags
)
530 switch(uFlags
& DCB_TYPEMASK
) {
531 case DCB_NULL
: return "null";
532 case DCB_WINDOW
: return "window";
533 case DCB_TASK
: return "task";
534 case DCB_EVENT
: return "event";
535 case DCB_FUNCTION
: return "32bit function";
536 default: return "UNKNOWN";
540 /**************************************************************************
541 * DriverCallback [WINMM.@]
543 BOOL WINAPI
DriverCallback(DWORD_PTR dwCallBack
, DWORD uFlags
, HDRVR hDev
,
544 DWORD wMsg
, DWORD_PTR dwUser
, DWORD_PTR dwParam1
,
548 TRACE("(%08lX, %s %04X, %p, %04X, %08lX, %08lX, %08lX)\n",
549 dwCallBack
, DRIVER_getCallback(uFlags
), uFlags
, hDev
, wMsg
, dwUser
, dwParam1
, dwParam2
);
553 switch (uFlags
& DCB_TYPEMASK
) {
555 /* Native returns FALSE = no notification, not TRUE */
558 ret
= PostMessageA((HWND
)dwCallBack
, wMsg
, (WPARAM
)hDev
, dwParam1
);
560 case DCB_TASK
: /* aka DCB_THREAD */
561 ret
= PostThreadMessageA(dwCallBack
, wMsg
, (WPARAM
)hDev
, dwParam1
);
564 ((LPDRVCALLBACK
)dwCallBack
)(hDev
, wMsg
, dwUser
, dwParam1
, dwParam2
);
568 ret
= SetEvent((HANDLE
)dwCallBack
);
571 /* FIXME: for now only usable in mmsystem.dll16
572 * If needed, should be enabled back
574 case 6: /* I would dub it DCB_MMTHREADSIGNAL */
575 /* this is an undocumented DCB_ value used for mmThreads
576 * loword of dwCallBack contains the handle of the lpMMThd block
577 * which dwSignalCount has to be incremented
579 if (pFnGetMMThread16
)
581 WINE_MMTHREAD
* lpMMThd
= pFnGetMMThread16(LOWORD(dwCallBack
));
583 TRACE("mmThread (%04x, %p) !\n", LOWORD(dwCallBack
), lpMMThd
);
584 /* same as mmThreadSignal16 */
585 InterlockedIncrement(&lpMMThd
->dwSignalCount
);
586 SetEvent(lpMMThd
->hEvent
);
587 /* some other stuff on lpMMThd->hVxD */
593 /* this is an undocumented DCB_ value for... I don't know */
597 WARN("Unknown callback type %d\n", uFlags
& DCB_TYPEMASK
);
603 WARN("Notification failure\n");
607 /******************************************************************
612 void DRIVER_UnloadAll(void)
615 LPWINE_DRIVER lpNextDrv
= NULL
;
619 EnterCriticalSection( &mmdriver_lock
);
621 for (lpDrv
= lpDrvItemList
; lpDrv
!= NULL
; lpDrv
= lpNextDrv
)
623 lpNextDrv
= lpDrv
->lpNextItem
;
625 /* session instances will be unloaded automatically */
626 if (!(lpDrv
->dwFlags
& WINE_GDF_SESSION
))
628 LeaveCriticalSection( &mmdriver_lock
);
629 CloseDriver((HDRVR
)lpDrv
, 0, 0);
631 /* restart from the beginning of the list */
636 LeaveCriticalSection( &mmdriver_lock
);
638 TRACE("Unloaded %u drivers\n", count
);