3 * COPYRIGHT: See COPYING in the top level directory
4 * PROJECT: ReactOS kernel
5 * FILE: drivers/dd/serial/pnp.c
6 * PURPOSE: Serial IRP_MJ_PNP operations
8 * PROGRAMMERS: Hervé Poussineau (poussine@freesurf.fr)
10 /* FIXME: call IoAcquireRemoveLock/IoReleaseRemoveLock around each I/O operation */
17 SerialAddDeviceInternal(
18 IN PDRIVER_OBJECT DriverObject
,
19 IN PDEVICE_OBJECT Pdo
,
20 IN UART_TYPE UartType
,
21 IN PULONG pComPortNumber OPTIONAL
,
22 OUT PDEVICE_OBJECT
* pFdo OPTIONAL
)
24 PDEVICE_OBJECT Fdo
= NULL
;
25 PSERIAL_DEVICE_EXTENSION DeviceExtension
= NULL
;
27 WCHAR DeviceNameBuffer
[32];
28 UNICODE_STRING DeviceName
;
29 static ULONG DeviceNumber
= 0;
30 static ULONG ComPortNumber
= 1;
32 DPRINT("Serial: SerialAddDeviceInternal called\n");
37 /* Create new device object */
38 swprintf(DeviceNameBuffer
, L
"\\Device\\Serial%lu", DeviceNumber
);
39 RtlInitUnicodeString(&DeviceName
, DeviceNameBuffer
);
40 Status
= IoCreateDevice(DriverObject
,
41 sizeof(SERIAL_DEVICE_EXTENSION
),
43 FILE_DEVICE_SERIAL_PORT
,
44 FILE_DEVICE_SECURE_OPEN
,
47 if (!NT_SUCCESS(Status
))
49 DPRINT("Serial: IoCreateDevice() failed with status 0x%08x\n", Status
);
53 DeviceExtension
= (PSERIAL_DEVICE_EXTENSION
)Fdo
->DeviceExtension
;
54 RtlZeroMemory(DeviceExtension
, sizeof(SERIAL_DEVICE_EXTENSION
));
56 /* Register device interface */
57 Status
= IoRegisterDeviceInterface(Pdo
, &GUID_DEVINTERFACE_COMPORT
, NULL
, &DeviceExtension
->SerialInterfaceName
);
58 if (!NT_SUCCESS(Status
))
60 DPRINT("Serial: IoRegisterDeviceInterface() failed with status 0x%08x\n", Status
);
64 DeviceExtension
->SerialPortNumber
= DeviceNumber
++;
65 if (pComPortNumber
== NULL
)
66 DeviceExtension
->ComPort
= ComPortNumber
++;
68 DeviceExtension
->ComPort
= *pComPortNumber
;
69 DeviceExtension
->Pdo
= Pdo
;
70 DeviceExtension
->PnpState
= dsStopped
;
71 DeviceExtension
->UartType
= UartType
;
72 Status
= InitializeCircularBuffer(&DeviceExtension
->InputBuffer
, 16);
73 if (!NT_SUCCESS(Status
)) goto ByeBye
;
74 Status
= InitializeCircularBuffer(&DeviceExtension
->OutputBuffer
, 16);
75 if (!NT_SUCCESS(Status
)) goto ByeBye
;
76 IoInitializeRemoveLock(&DeviceExtension
->RemoveLock
, SERIAL_TAG
, 0, 0);
77 KeInitializeSpinLock(&DeviceExtension
->InputBufferLock
);
78 KeInitializeSpinLock(&DeviceExtension
->OutputBufferLock
);
79 KeInitializeEvent(&DeviceExtension
->InputBufferNotEmpty
, NotificationEvent
, FALSE
);
80 KeInitializeDpc(&DeviceExtension
->ReceivedByteDpc
, SerialReceiveByte
, DeviceExtension
);
81 KeInitializeDpc(&DeviceExtension
->SendByteDpc
, SerialSendByte
, DeviceExtension
);
82 Fdo
->Flags
|= DO_POWER_PAGABLE
;
83 Status
= IoAttachDeviceToDeviceStackSafe(Fdo
, Pdo
, &DeviceExtension
->LowerDevice
);
84 if (!NT_SUCCESS(Status
))
86 DPRINT("Serial: IoAttachDeviceToDeviceStackSafe() failed with status 0x%08x\n", Status
);
89 Fdo
->Flags
|= DO_BUFFERED_IO
;
90 Fdo
->Flags
&= ~DO_DEVICE_INITIALIZING
;
96 return STATUS_SUCCESS
;
101 FreeCircularBuffer(&DeviceExtension
->InputBuffer
);
102 FreeCircularBuffer(&DeviceExtension
->OutputBuffer
);
110 IN PDRIVER_OBJECT DriverObject
,
111 IN PDEVICE_OBJECT Pdo
)
113 /* Serial.sys is a legacy driver. AddDevice is called once
114 * with a NULL Pdo just after the driver initialization.
115 * Detect this case and return success.
118 return STATUS_SUCCESS
;
120 /* We have here a PDO not null. It represents a real serial
121 * port. So call the internal AddDevice function.
123 return SerialAddDeviceInternal(DriverObject
, Pdo
, UartUnknown
, NULL
, NULL
);
127 SerialPnpStartDevice(
128 IN PDEVICE_OBJECT DeviceObject
,
129 IN PCM_RESOURCE_LIST ResourceList
)
131 PSERIAL_DEVICE_EXTENSION DeviceExtension
;
132 WCHAR DeviceNameBuffer
[32];
133 UNICODE_STRING DeviceName
;
134 WCHAR LinkNameBuffer
[32];
135 UNICODE_STRING LinkName
;
136 WCHAR ComPortBuffer
[32];
137 UNICODE_STRING ComPort
;
142 KAFFINITY Affinity
= 0;
143 KINTERRUPT_MODE InterruptMode
= Latched
;
144 BOOLEAN ShareInterrupt
= TRUE
;
145 OBJECT_ATTRIBUTES objectAttributes
;
147 UNICODE_STRING KeyName
;
151 DeviceExtension
= (PSERIAL_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
;
153 ASSERT(ResourceList
);
154 ASSERT(DeviceExtension
);
155 ASSERT(DeviceExtension
->PnpState
== dsStopped
);
157 DeviceExtension
->BaudRate
= 19200;
158 DeviceExtension
->BaseAddress
= 0;
160 for (i
= 0; i
< ResourceList
->Count
; i
++)
162 for (j
= 0; j
< ResourceList
->List
[i
].PartialResourceList
.Count
; j
++)
164 PCM_PARTIAL_RESOURCE_DESCRIPTOR PartialDescriptor
= &ResourceList
->List
[i
].PartialResourceList
.PartialDescriptors
[j
];
165 switch (PartialDescriptor
->Type
)
167 case CmResourceTypePort
:
168 if (PartialDescriptor
->u
.Port
.Length
< 8)
169 return STATUS_INSUFFICIENT_RESOURCES
;
170 if (DeviceExtension
->BaseAddress
!= 0)
171 return STATUS_UNSUCCESSFUL
;
172 DeviceExtension
->BaseAddress
= PartialDescriptor
->u
.Port
.Start
.u
.LowPart
;
174 case CmResourceTypeInterrupt
:
176 return STATUS_UNSUCCESSFUL
;
177 Dirql
= (KIRQL
)PartialDescriptor
->u
.Interrupt
.Level
;
178 Vector
= PartialDescriptor
->u
.Interrupt
.Vector
;
179 Affinity
= PartialDescriptor
->u
.Interrupt
.Affinity
;
180 if (PartialDescriptor
->Flags
& CM_RESOURCE_INTERRUPT_LATCHED
)
181 InterruptMode
= Latched
;
183 InterruptMode
= LevelSensitive
;
184 ShareInterrupt
= (PartialDescriptor
->ShareDisposition
== CmResourceShareShared
);
189 DPRINT("Serial: New COM port. Base = 0x%lx, Irql = %u\n",
190 DeviceExtension
->BaseAddress
, Dirql
);
191 if (!DeviceExtension
->BaseAddress
)
192 return STATUS_INSUFFICIENT_RESOURCES
;
194 return STATUS_INSUFFICIENT_RESOURCES
;
195 ComPortBase
= (PUCHAR
)DeviceExtension
->BaseAddress
;
197 if (DeviceExtension
->UartType
== UartUnknown
)
198 DeviceExtension
->UartType
= SerialDetectUartType(ComPortBase
);
200 /* Get current settings */
201 DeviceExtension
->MCR
= READ_PORT_UCHAR(SER_MCR(ComPortBase
));
202 DeviceExtension
->MSR
= READ_PORT_UCHAR(SER_MSR(ComPortBase
));
203 DeviceExtension
->WaitMask
= 0;
206 Status
= SerialSetBaudRate(DeviceExtension
, DeviceExtension
->BaudRate
);
207 if (!NT_SUCCESS(Status
))
209 DPRINT("Serial: SerialSetBaudRate() failed with status 0x%08x\n", Status
);
213 /* Set line control */
214 DeviceExtension
->SerialLineControl
.StopBits
= STOP_BIT_1
;
215 DeviceExtension
->SerialLineControl
.Parity
= NO_PARITY
;
216 DeviceExtension
->SerialLineControl
.WordLength
= 8;
217 Status
= SerialSetLineControl(DeviceExtension
, &DeviceExtension
->SerialLineControl
);
218 if (!NT_SUCCESS(Status
))
220 DPRINT("Serial: SerialSetLineControl() failed with status 0x%08x\n", Status
);
224 /* Clear receive/transmit buffers */
225 if (DeviceExtension
->UartType
>= Uart16550A
)
227 /* 16550 UARTs also have FIFO queues, but they are unusable due to a bug */
228 WRITE_PORT_UCHAR(SER_FCR(ComPortBase
),
229 SR_FCR_CLEAR_RCVR
| SR_FCR_CLEAR_XMIT
);
232 /* Create link \DosDevices\COMX -> \Device\SerialX */
233 swprintf(DeviceNameBuffer
, L
"\\Device\\Serial%lu", DeviceExtension
->SerialPortNumber
);
234 swprintf(LinkNameBuffer
, L
"\\DosDevices\\COM%lu", DeviceExtension
->ComPort
);
235 swprintf(ComPortBuffer
, L
"COM%lu", DeviceExtension
->ComPort
);
236 RtlInitUnicodeString(&DeviceName
, DeviceNameBuffer
);
237 RtlInitUnicodeString(&LinkName
, LinkNameBuffer
);
238 RtlInitUnicodeString(&ComPort
, ComPortBuffer
);
239 Status
= IoCreateSymbolicLink(&LinkName
, &DeviceName
);
240 if (!NT_SUCCESS(Status
))
242 DPRINT("Serial: IoCreateSymbolicLink() failed with status 0x%08x\n", Status
);
246 /* Activate serial interface */
247 Status
= IoSetDeviceInterfaceState(&DeviceExtension
->SerialInterfaceName
, TRUE
);
248 if (!NT_SUCCESS(Status
))
250 DPRINT("Serial: IoSetDeviceInterfaceState() failed with status 0x%08x\n", Status
);
251 IoDeleteSymbolicLink(&LinkName
);
255 /* Connect interrupt and enable them */
256 Status
= IoConnectInterrupt(
257 &DeviceExtension
->Interrupt
, SerialInterruptService
,
259 Vector
, Dirql
, Dirql
,
260 InterruptMode
, ShareInterrupt
,
262 if (!NT_SUCCESS(Status
))
264 DPRINT("Serial: IoConnectInterrupt() failed with status 0x%08x\n", Status
);
265 IoSetDeviceInterfaceState(&DeviceExtension
->SerialInterfaceName
, FALSE
);
266 IoDeleteSymbolicLink(&LinkName
);
270 /* Write an entry value under HKLM\HARDWARE\DeviceMap\SERIALCOMM */
271 /* This step is not mandatory, so don't exit in case of error */
272 RtlInitUnicodeString(&KeyName
, L
"\\Registry\\Machine\\HARDWARE\\DeviceMap\\SERIALCOMM");
273 InitializeObjectAttributes(&objectAttributes
, &KeyName
, OBJ_CASE_INSENSITIVE
, NULL
, NULL
);
274 Status
= ZwCreateKey(&hKey
, KEY_SET_VALUE
, &objectAttributes
, 0, NULL
, REG_OPTION_VOLATILE
, NULL
);
275 if (NT_SUCCESS(Status
))
277 /* Key = \Device\Serialx, Value = COMx */
278 ZwSetValueKey(hKey
, &DeviceName
, 0, REG_SZ
, &ComPortBuffer
, ComPort
.Length
+ sizeof(WCHAR
));
282 DeviceExtension
->PnpState
= dsStarted
;
284 /* Activate interrupt modes */
285 IER
= READ_PORT_UCHAR(SER_IER(ComPortBase
));
286 IER
|= SR_IER_DATA_RECEIVED
| SR_IER_THR_EMPTY
| SR_IER_LSR_CHANGE
| SR_IER_MSR_CHANGE
;
287 WRITE_PORT_UCHAR(SER_IER(ComPortBase
), IER
);
289 /* Activate DTR, RTS */
290 DeviceExtension
->MCR
|= SR_MCR_DTR
| SR_MCR_RTS
;
291 WRITE_PORT_UCHAR(SER_MCR(ComPortBase
), DeviceExtension
->MCR
);
293 return STATUS_SUCCESS
;
298 IN PDEVICE_OBJECT DeviceObject
,
302 PIO_STACK_LOCATION Stack
;
303 ULONG_PTR Information
= 0;
306 Stack
= IoGetCurrentIrpStackLocation(Irp
);
307 MinorFunction
= Stack
->MinorFunction
;
309 switch (MinorFunction
)
311 /* FIXME: do all these minor functions
312 IRP_MN_QUERY_REMOVE_DEVICE 0x1
313 IRP_MN_REMOVE_DEVICE 0x2
315 DPRINT("Serial: IRP_MJ_PNP / IRP_MN_REMOVE_DEVICE\n");
317 IoReleaseRemoveLockAndWait
318 pass request to DeviceExtension-LowerDriver
320 IoDeleteDevice(Fdo) and/or IoDetachDevice
323 IRP_MN_CANCEL_REMOVE_DEVICE 0x3
324 IRP_MN_STOP_DEVICE 0x4
325 IRP_MN_QUERY_STOP_DEVICE 0x5
326 IRP_MN_CANCEL_STOP_DEVICE 0x6
327 IRP_MN_QUERY_DEVICE_RELATIONS / BusRelations (optional) 0x7
328 IRP_MN_QUERY_DEVICE_RELATIONS / RemovalRelations (optional) 0x7
329 IRP_MN_QUERY_INTERFACE (optional) 0x8
330 IRP_MN_QUERY_CAPABILITIES (optional) 0x9
331 IRP_MN_FILTER_RESOURCE_REQUIREMENTS (optional) 0xd
332 IRP_MN_QUERY_PNP_DEVICE_STATE (optional) 0x14
333 IRP_MN_DEVICE_USAGE_NOTIFICATION (required or optional) 0x16
334 IRP_MN_SURPRISE_REMOVAL 0x17
336 case IRP_MN_START_DEVICE
: /* 0x0 */
338 BOOLEAN ConflictDetected
;
339 DPRINT("Serial: IRP_MJ_PNP / IRP_MN_START_DEVICE\n");
341 /* FIXME: first HACK: PnP manager can send multiple
342 * IRP_MN_START_DEVICE for one device
344 if (((PSERIAL_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
)->PnpState
!= dsStopped
)
346 DPRINT1("Serial: device already started. Ignoring this irp!\n");
347 Status
= STATUS_SUCCESS
;
350 /* FIXME: second HACK: verify that we have some allocated resources.
351 * It seems not to be always the case on some hardware
353 if (Stack
->Parameters
.StartDevice
.AllocatedResources
== NULL
)
355 DPRINT1("Serial: no allocated resources. Can't start COM%lu\n",
356 ((PSERIAL_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
)->ComPort
);
357 Status
= STATUS_INSUFFICIENT_RESOURCES
;
360 /* FIXME: third HACK: verify that we don't have resource conflict,
361 * because PnP manager doesn't do it automatically
363 Status
= IoReportResourceForDetection(
364 DeviceObject
->DriverObject
, Stack
->Parameters
.StartDevice
.AllocatedResources
, 0,
367 if (!NT_SUCCESS(Status
))
369 Irp
->IoStatus
.Information
= 0;
370 Irp
->IoStatus
.Status
= Status
;
371 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
375 /* Call lower driver */
376 Status
= ForwardIrpAndWait(DeviceObject
, Irp
);
377 if (NT_SUCCESS(Status
))
378 Status
= SerialPnpStartDevice(
380 Stack
->Parameters
.StartDevice
.AllocatedResources
);
383 case IRP_MN_QUERY_DEVICE_RELATIONS
: /* (optional) 0x7 */
385 switch (Stack
->Parameters
.QueryDeviceRelations
.Type
)
389 DPRINT("Serial: IRP_MJ_PNP / IRP_MN_QUERY_DEVICE_RELATIONS / BusRelations\n");
390 return ForwardIrpAndForget(DeviceObject
, Irp
);
392 case RemovalRelations
:
394 DPRINT("Serial: IRP_MJ_PNP / IRP_MN_QUERY_DEVICE_RELATIONS / RemovalRelations\n");
395 return ForwardIrpAndForget(DeviceObject
, Irp
);
398 DPRINT1("Serial: IRP_MJ_PNP / IRP_MN_QUERY_DEVICE_RELATIONS / Unknown type 0x%lx\n",
399 Stack
->Parameters
.QueryDeviceRelations
.Type
);
400 return ForwardIrpAndForget(DeviceObject
, Irp
);
406 DPRINT1("Serial: unknown minor function 0x%x\n", MinorFunction
);
407 return ForwardIrpAndForget(DeviceObject
, Irp
);
411 Irp
->IoStatus
.Information
= Information
;
412 Irp
->IoStatus
.Status
= Status
;
413 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);