ReactOS  0.4.14-dev-41-g31d7680
api.cpp
Go to the documentation of this file.
1 /*
2  * COPYRIGHT: See COPYING in the top level directory
3  * PROJECT: ReactOS Kernel Streaming
4  * FILE: drivers/wdm/audio/backpln/portcls/api.cpp
5  * PURPOSE: Port api functions
6  * PROGRAMMER: Johannes Anderwald
7  */
8 
9 #include "private.hpp"
10 
11 #ifndef YDEBUG
12 #define NDEBUG
13 #endif
14 
15 #include <debug.h>
16 
18 NTAPI
23  OUT PVOID PropertyBuffer,
25 {
26  PPCLASS_DEVICE_EXTENSION DeviceExtension;
27 
29 
30  DeviceExtension = (PPCLASS_DEVICE_EXTENSION)((PDEVICE_OBJECT)DeviceObject)->DeviceExtension;
31 
32  return IoGetDeviceProperty(DeviceExtension->PhysicalDeviceObject, DeviceProperty, BufferLength, PropertyBuffer, ResultLength);
33 }
34 
36 NTAPI
38  IN ULONGLONG Since)
39 {
40  LARGE_INTEGER CurrentTime;
41 
42  KeQuerySystemTime(&CurrentTime);
43 
44  return (CurrentTime.QuadPart - Since);
45 }
46 
47 VOID
48 NTAPI
52 {
53  PPCLASS_DEVICE_EXTENSION DeviceExtension;
54  KIRQL OldIrql;
55  PLIST_ENTRY ListEntry;
56  PTIMER_CONTEXT CurContext;
57 
59  return;
60 
62 
63  KeAcquireSpinLock(&DeviceExtension->TimerListLock, &OldIrql);
64 
65  ListEntry = DeviceExtension->TimerList.Flink;
66  while(ListEntry != &DeviceExtension->TimerList)
67  {
68  CurContext = (PTIMER_CONTEXT)CONTAINING_RECORD(ListEntry, TIMER_CONTEXT, Entry);
69 
70  CurContext->pTimerRoutine(DeviceObject, CurContext->Context);
71  ListEntry = ListEntry->Flink;
72  }
73 
74  KeReleaseSpinLock(&DeviceExtension->TimerListLock, OldIrql);
75 }
76 
78 NTAPI
81  IN PIO_TIMER_ROUTINE pTimerRoutine,
82  IN PVOID pContext)
83 {
85  PTIMER_CONTEXT TimerContext, CurContext;
86  KIRQL OldIrql;
87  PLIST_ENTRY ListEntry;
88  BOOLEAN bFound;
89  PPCLASS_DEVICE_EXTENSION DeviceExtension;
90 
92 
93  if (!pDeviceObject || !pDeviceObject->DeviceExtension)
95 
96  DeviceExtension = (PPCLASS_DEVICE_EXTENSION)pDeviceObject->DeviceExtension;
97 
99  if (!TimerContext)
100  {
101  DPRINT("Failed to allocate memory\n");
103  }
104 
105  KeAcquireSpinLock(&DeviceExtension->TimerListLock, &OldIrql);
106 
107  ListEntry = DeviceExtension->TimerList.Flink;
108  bFound = FALSE;
109  while(ListEntry != &DeviceExtension->TimerList)
110  {
111  CurContext = (PTIMER_CONTEXT)CONTAINING_RECORD(ListEntry, TIMER_CONTEXT, Entry);
112 
113  if (CurContext->Context == pContext && CurContext->pTimerRoutine == pTimerRoutine)
114  {
115  bFound = TRUE;
118  break;
119  }
120  ListEntry = ListEntry->Flink;
121  }
122 
123  if (!bFound)
124  {
125  TimerContext->Context = pContext;
126  TimerContext->pTimerRoutine = pTimerRoutine;
127  InsertTailList(&DeviceExtension->TimerList, &TimerContext->Entry);
128  }
129 
130  KeReleaseSpinLock(&DeviceExtension->TimerListLock, OldIrql);
131 
132  return Status;
133 }
134 
135 NTSTATUS
136 NTAPI
139  IN PIO_TIMER_ROUTINE pTimerRoutine,
140  IN PVOID pContext)
141 {
142  PTIMER_CONTEXT CurContext;
143  KIRQL OldIrql;
144  PLIST_ENTRY ListEntry;
145  BOOLEAN bFound;
146  PPCLASS_DEVICE_EXTENSION DeviceExtension;
147 
149 
150  if (!pDeviceObject || !pDeviceObject->DeviceExtension)
152 
153 
154  DeviceExtension = (PPCLASS_DEVICE_EXTENSION)pDeviceObject->DeviceExtension;
155 
156 
157  KeAcquireSpinLock(&DeviceExtension->TimerListLock, &OldIrql);
158 
159  ListEntry = DeviceExtension->TimerList.Flink;
160  bFound = FALSE;
161 
162  while(ListEntry != &DeviceExtension->TimerList)
163  {
164  CurContext = (PTIMER_CONTEXT)CONTAINING_RECORD(ListEntry, TIMER_CONTEXT, Entry);
165 
166  if (CurContext->Context == pContext && CurContext->pTimerRoutine == pTimerRoutine)
167  {
168  bFound = TRUE;
169  RemoveEntryList(&CurContext->Entry);
170  FreeItem(CurContext, TAG_PORTCLASS);
171  break;
172  }
173  ListEntry = ListEntry->Flink;
174  }
175 
176  KeReleaseSpinLock(&DeviceExtension->TimerListLock, OldIrql);
177 
178  if (bFound)
179  return STATUS_SUCCESS;
180  else
181  return STATUS_NOT_FOUND;
182 }
183 
184 
185 
186 NTSTATUS
187 NTAPI
189  IN PPCPROPERTY_REQUEST PropertyRequest,
190  IN NTSTATUS NtStatus)
191 {
192  // sanity checks
194 
195  if (!PropertyRequest || !PropertyRequest->Irp || NtStatus == STATUS_PENDING)
197 
198  // set the final status code
199  PropertyRequest->Irp->IoStatus.Status = NtStatus;
200 
201  // complete the irp
202  IoCompleteRequest(PropertyRequest->Irp, IO_SOUND_INCREMENT);
203 
204  // free the property request
205  FreeItem(PropertyRequest, TAG_PORTCLASS);
206 
207  // return success
208  return STATUS_SUCCESS;
209 }
210 
211 NTSTATUS
212 NTAPI
216  IN BOOLEAN Dma32BitAddresses,
217  IN BOOLEAN IgnoreCount,
219  IN DMA_WIDTH DmaWidth,
220  IN DMA_SPEED DmaSpeed,
222  IN ULONG DmaPort,
224 {
225 
227 
231  DeviceDescription->Dma32BitAddresses = Dma32BitAddresses;
232  DeviceDescription->IgnoreCount = IgnoreCount;
234  DeviceDescription->DmaWidth = DmaWidth;
235  DeviceDescription->DmaSpeed = DmaSpeed;
237  DeviceDescription->DmaPort = DmaPort;
238 
239  return STATUS_SUCCESS;
240 }
241 
242 NTSTATUS
243 NTAPI
246  IN ULONG DmaIndex,
247  IN BOOLEAN DemandMode,
248  IN BOOLEAN AutoInitialize,
249  IN DMA_SPEED DmaSpeed,
251  IN ULONG DmaPort,
253 {
254 
256 
258  DeviceDescription->DemandMode = DemandMode;
259  DeviceDescription->AutoInitialize = AutoInitialize;
260  DeviceDescription->DmaSpeed = DmaSpeed;
262  DeviceDescription->DmaPort = DmaPort;
263 
264  return STATUS_SUCCESS;
265 }
266 
#define KeQuerySystemTime(t)
Definition: env_spec_w32.h:570
IN CINT OUT PVOID IN ULONG OUT PULONG ResultLength
Definition: conport.c:47
DEVICE_REGISTRY_PROPERTY
Definition: iotypes.h:1154
#define IN
Definition: typedefs.h:38
_In_ PNDIS_STRING _In_ PNDIS_STRING _Out_ PDEVICE_OBJECT * pDeviceObject
Definition: ndis.h:4679
#define TRUE
Definition: types.h:120
#define STATUS_INSUFFICIENT_RESOURCES
Definition: udferr_usr.h:158
VOID NTAPI PcIoTimerRoutine(IN PDEVICE_OBJECT DeviceObject, IN PVOID Context)
Definition: api.cpp:49
PVOID Context
Definition: private.hpp:432
struct TIMER_CONTEXT * PTIMER_CONTEXT
NTSTATUS NTAPI PcDmaSlaveDescription(IN PRESOURCELIST ResourceList OPTIONAL, IN ULONG DmaIndex, IN BOOLEAN DemandMode, IN BOOLEAN AutoInitialize, IN DMA_SPEED DmaSpeed, IN ULONG MaximumLength, IN ULONG DmaPort, OUT PDEVICE_DESCRIPTION DeviceDescription)
Definition: api.cpp:244
struct PCLASS_DEVICE_EXTENSION * PPCLASS_DEVICE_EXTENSION
#define STATUS_INVALID_PARAMETER
Definition: udferr_usr.h:135
#define TAG_PORTCLASS
Definition: private.hpp:24
PIO_TIMER_ROUTINE pTimerRoutine
Definition: private.hpp:431
PVOID AllocateItem(IN POOL_TYPE PoolType, IN SIZE_T NumberOfBytes)
Definition: misc.c:30
LONG NTSTATUS
Definition: precomp.h:26
DMA_SPEED DmaSpeed
Definition: iotypes.h:2038
ULONGLONG NTAPI PcGetTimeInterval(IN ULONGLONG Since)
Definition: api.cpp:37
enum _DMA_WIDTH DMA_WIDTH
#define InsertTailList(ListHead, Entry)
const MUI_LANGUAGE_RESOURCE ResourceList[]
Definition: muilanguages.h:414
#define IO_SOUND_INCREMENT
Definition: iotypes.h:576
FORCEINLINE BOOLEAN RemoveEntryList(_In_ PLIST_ENTRY Entry)
Definition: rtlfuncs.h:105
UCHAR KIRQL
Definition: env_spec_w32.h:591
VOID FreeItem(IN PVOID Item)
Definition: misc.c:43
NTSTATUS(* NTAPI)(IN PFILE_FULL_EA_INFORMATION EaBuffer, IN ULONG EaLength, OUT PULONG ErrorOffset)
Definition: IoEaTest.cpp:117
_In_ ULONG BufferLength
Definition: usbdlib.h:225
BOOLEAN IgnoreCount
Definition: iotypes.h:2031
_In_ BOOLEAN Dma64BitAddresses
Definition: ndis.h:4652
PVOID DeviceExtension
Definition: env_spec_w32.h:418
unsigned char BOOLEAN
#define IoCompleteRequest
Definition: irp.c:1240
NTSTATUS NTAPI IoGetDeviceProperty(IN PDEVICE_OBJECT DeviceObject, IN DEVICE_REGISTRY_PROPERTY DeviceProperty, IN ULONG BufferLength, OUT PVOID PropertyBuffer, OUT PULONG ResultLength)
Definition: pnpmgr.c:4228
void DPRINT(...)
Definition: polytest.cpp:61
KSPIN_LOCK TimerListLock
Definition: private.hpp:413
PFLT_MESSAGE_WAITER_QUEUE CONTAINING_RECORD(Csq, DEVICE_EXTENSION, IrpQueue)) -> WaiterQ.mLock) _IRQL_raises_(DISPATCH_LEVEL) VOID NTAPI FltpAcquireMessageWaiterLock(_In_ PIO_CSQ Csq, _Out_ PKIRQL Irql)
Definition: Messaging.c:560
BOOLEAN Dma32BitAddresses
Definition: iotypes.h:2030
NTSTATUS NTAPI PcGetDeviceProperty(IN PVOID DeviceObject, IN DEVICE_REGISTRY_PROPERTY DeviceProperty, IN ULONG BufferLength, OUT PVOID PropertyBuffer, OUT PULONG ResultLength)
Definition: api.cpp:19
BOOLEAN Dma64BitAddresses
Definition: iotypes.h:2033
_Must_inspect_result_ _In_ PDEVICE_DESCRIPTION DeviceDescription
Definition: iofuncs.h:1015
struct _LIST_ENTRY * Flink
Definition: typedefs.h:119
#define STATUS_NOT_FOUND
Definition: shellext.h:67
#define STATUS_PENDING
Definition: ntstatus.h:82
BOOLEAN DemandMode
Definition: iotypes.h:2028
PDEVICE_OBJECT PhysicalDeviceObject
Definition: private.hpp:402
uint64_t ULONGLONG
Definition: typedefs.h:65
BOOLEAN ScatterGather
Definition: iotypes.h:2027
#define KeAcquireSpinLock(sl, irql)
Definition: env_spec_w32.h:609
#define PC_ASSERT_IRQL_EQUAL(x)
Definition: private.hpp:31
DMA_WIDTH DmaWidth
Definition: iotypes.h:2037
#define STATUS_UNSUCCESSFUL
Definition: udferr_usr.h:132
_Requires_lock_held_ Interrupt _Releases_lock_ Interrupt _In_ _IRQL_restores_ KIRQL OldIrql
Definition: kefuncs.h:803
Definition: typedefs.h:117
#define PASSIVE_LEVEL
Definition: env_spec_w32.h:693
NTSTATUS NTAPI PcRegisterIoTimeout(IN PDEVICE_OBJECT pDeviceObject, IN PIO_TIMER_ROUTINE pTimerRoutine, IN PVOID pContext)
Definition: api.cpp:79
Status
Definition: gdiplustypes.h:24
enum _DMA_SPEED DMA_SPEED
IResourceList * PRESOURCELIST
Definition: portcls.h:442
NTSTATUS NTAPI PcUnregisterIoTimeout(IN PDEVICE_OBJECT pDeviceObject, IN PIO_TIMER_ROUTINE pTimerRoutine, IN PVOID pContext)
Definition: api.cpp:137
#define DISPATCH_LEVEL
Definition: env_spec_w32.h:696
UnicodeString MaximumLength
Definition: rtlfuncs.h:2982
IN PDEVICE_OBJECT DeviceObject
Definition: fatprocs.h:1560
_In_ DEVICE_REGISTRY_PROPERTY DeviceProperty
Definition: iofuncs.h:1003
NTSTATUS NTAPI PcDmaMasterDescription(IN PRESOURCELIST ResourceList OPTIONAL, IN BOOLEAN ScatterGather, IN BOOLEAN Dma32BitAddresses, IN BOOLEAN IgnoreCount, IN BOOLEAN Dma64BitAddresses, IN DMA_WIDTH DmaWidth, IN DMA_SPEED DmaSpeed, IN ULONG MaximumLength, IN ULONG DmaPort, OUT PDEVICE_DESCRIPTION DeviceDescription)
Definition: api.cpp:213
unsigned int * PULONG
Definition: retypes.h:1
_In_ struct _IRP _In_ struct _SCATTER_GATHER_LIST * ScatterGather
Definition: iotypes.h:2259
#define KeReleaseSpinLock(sl, irql)
Definition: env_spec_w32.h:627
LIST_ENTRY Entry
Definition: private.hpp:430
#define OUT
Definition: typedefs.h:39
IO_TIMER_ROUTINE * PIO_TIMER_ROUTINE
Definition: iotypes.h:2508
unsigned int ULONG
Definition: retypes.h:1
_In_ PLARGE_INTEGER _In_opt_ PTIMER_APC_ROUTINE _In_opt_ PVOID TimerContext
Definition: zwfuncs.h:428
#define RtlZeroMemory(Destination, Length)
Definition: typedefs.h:261
NTSTATUS NTAPI PcCompletePendingPropertyRequest(IN PPCPROPERTY_REQUEST PropertyRequest, IN NTSTATUS NtStatus)
Definition: api.cpp:188
#define DEVICE_DESCRIPTION_VERSION1
Definition: iotypes.h:2021
return STATUS_SUCCESS
Definition: btrfs.c:2966
base of all file and directory entries
Definition: entries.h:82
BOOLEAN AutoInitialize
Definition: iotypes.h:2029
#define PC_ASSERT_IRQL(x)
Definition: private.hpp:30
LONGLONG QuadPart
Definition: typedefs.h:112
PULONG MinorVersion OPTIONAL
Definition: CrossNt.h:68