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 //UNICODE_STRING SymbolicLinkName;
30 static ULONG DeviceNumber
= 0;
31 static ULONG ComPortNumber
= 1;
33 DPRINT("Serial: SerialAddDeviceInternal called\n");
35 /* Create new device object */
36 swprintf(DeviceNameBuffer
, L
"\\Device\\Serial%lu", DeviceNumber
);
37 RtlInitUnicodeString(&DeviceName
, DeviceNameBuffer
);
38 Status
= IoCreateDevice(DriverObject
,
39 sizeof(SERIAL_DEVICE_EXTENSION
),
41 FILE_DEVICE_SERIAL_PORT
,
42 FILE_DEVICE_SECURE_OPEN
,
45 if (!NT_SUCCESS(Status
))
47 DPRINT("Serial: IoCreateDevice() failed with status 0x%08x\n", Status
);
51 DeviceExtension
= (PSERIAL_DEVICE_EXTENSION
)Fdo
->DeviceExtension
;
52 RtlZeroMemory(DeviceExtension
, sizeof(SERIAL_DEVICE_EXTENSION
));
54 /* Register device interface */
55 #if 0 /* FIXME: activate */
56 Status
= IoRegisterDeviceInterface(Pdo
, &GUID_DEVINTERFACE_COMPORT
, NULL
, &SymbolicLinkName
);
57 if (!NT_SUCCESS(Status
))
59 DPRINT("Serial: IoRegisterDeviceInterface() failed with status 0x%08x\n", Status
);
62 DPRINT1("Serial: IoRegisterDeviceInterface() returned '%wZ'\n", &SymbolicLinkName
);
63 Status
= IoSetDeviceInterfaceState(&SymbolicLinkName
, TRUE
);
64 if (!NT_SUCCESS(Status
))
66 DPRINT("Serial: IoSetDeviceInterfaceState() failed with status 0x%08x\n", Status
);
69 RtlFreeUnicodeString(&SymbolicLinkName
);
72 DeviceExtension
->SerialPortNumber
= DeviceNumber
++;
73 if (pComPortNumber
== NULL
)
74 DeviceExtension
->ComPort
= ComPortNumber
++;
76 DeviceExtension
->ComPort
= *pComPortNumber
;
77 DeviceExtension
->Pdo
= Pdo
;
78 DeviceExtension
->PnpState
= dsStopped
;
79 DeviceExtension
->UartType
= UartType
;
80 Status
= InitializeCircularBuffer(&DeviceExtension
->InputBuffer
, 16);
81 if (!NT_SUCCESS(Status
)) goto ByeBye
;
82 Status
= InitializeCircularBuffer(&DeviceExtension
->OutputBuffer
, 16);
83 if (!NT_SUCCESS(Status
)) goto ByeBye
;
84 IoInitializeRemoveLock(&DeviceExtension
->RemoveLock
, SERIAL_TAG
, 0, 0);
85 KeInitializeSpinLock(&DeviceExtension
->InputBufferLock
);
86 KeInitializeSpinLock(&DeviceExtension
->OutputBufferLock
);
87 KeInitializeEvent(&DeviceExtension
->InputBufferNotEmpty
, NotificationEvent
, FALSE
);
88 KeInitializeDpc(&DeviceExtension
->ReceivedByteDpc
, SerialReceiveByte
, DeviceExtension
);
89 KeInitializeDpc(&DeviceExtension
->SendByteDpc
, SerialSendByte
, DeviceExtension
);
90 Fdo
->Flags
|= DO_POWER_PAGABLE
;
91 Status
= IoAttachDeviceToDeviceStackSafe(Fdo
, Pdo
, &DeviceExtension
->LowerDevice
);
92 if (!NT_SUCCESS(Status
))
94 DPRINT("Serial: IoAttachDeviceToDeviceStackSafe() failed with status 0x%08x\n", Status
);
97 Fdo
->Flags
|= DO_BUFFERED_IO
;
98 Fdo
->Flags
&= ~DO_DEVICE_INITIALIZING
;
104 return STATUS_SUCCESS
;
109 FreeCircularBuffer(&DeviceExtension
->InputBuffer
);
110 FreeCircularBuffer(&DeviceExtension
->OutputBuffer
);
118 IN PDRIVER_OBJECT DriverObject
,
119 IN PDEVICE_OBJECT Pdo
)
121 /* Serial.sys is a legacy driver. AddDevice is called once
122 * with a NULL Pdo just after the driver initialization.
123 * Detect this case and return success.
126 return STATUS_SUCCESS
;
128 /* We have here a PDO that does not correspond to a legacy
129 * serial port. So call the internal AddDevice function.
131 return SerialAddDeviceInternal(DriverObject
, Pdo
, UartUnknown
, NULL
, NULL
);
137 SerialPnpStartDevice(
138 IN PDEVICE_OBJECT DeviceObject
,
139 IN PCM_RESOURCE_LIST ResourceList
)
141 PSERIAL_DEVICE_EXTENSION DeviceExtension
;
142 WCHAR DeviceNameBuffer
[32];
143 UNICODE_STRING DeviceName
;
144 WCHAR LinkNameBuffer
[32];
145 UNICODE_STRING LinkName
;
146 WCHAR ComPortBuffer
[32];
147 UNICODE_STRING ComPort
;
152 KAFFINITY Affinity
= 0;
153 KINTERRUPT_MODE InterruptMode
= Latched
;
154 BOOLEAN ShareInterrupt
= TRUE
;
155 OBJECT_ATTRIBUTES objectAttributes
;
157 UNICODE_STRING KeyName
;
161 DeviceExtension
= (PSERIAL_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
;
163 ASSERT(DeviceExtension
->PnpState
== dsStopped
);
165 DeviceExtension
->BaudRate
= 19200 | SERIAL_BAUD_USER
;
166 DeviceExtension
->BaseAddress
= 0;
168 for (i
= 0; i
< ResourceList
->Count
; i
++)
170 for (j
= 0; j
< ResourceList
->List
[i
].PartialResourceList
.Count
; j
++)
172 PCM_PARTIAL_RESOURCE_DESCRIPTOR PartialDescriptor
= &ResourceList
->List
[i
].PartialResourceList
.PartialDescriptors
[j
];
173 switch (PartialDescriptor
->Type
)
175 case CmResourceTypePort
:
176 if (PartialDescriptor
->u
.Port
.Length
< 8)
177 return STATUS_INSUFFICIENT_RESOURCES
;
178 if (DeviceExtension
->BaseAddress
!= 0)
179 return STATUS_UNSUCCESSFUL
;
180 DeviceExtension
->BaseAddress
= PartialDescriptor
->u
.Port
.Start
.u
.LowPart
;
182 case CmResourceTypeInterrupt
:
184 return STATUS_UNSUCCESSFUL
;
185 Dirql
= (KIRQL
)PartialDescriptor
->u
.Interrupt
.Level
;
186 Vector
= PartialDescriptor
->u
.Interrupt
.Vector
;
187 Affinity
= PartialDescriptor
->u
.Interrupt
.Affinity
;
188 if (PartialDescriptor
->Flags
& CM_RESOURCE_INTERRUPT_LATCHED
)
189 InterruptMode
= Latched
;
191 InterruptMode
= LevelSensitive
;
192 ShareInterrupt
= (PartialDescriptor
->ShareDisposition
== CmResourceShareShared
);
197 DPRINT("Serial: New COM port. Base = 0x%lx, Irql = %u\n",
198 DeviceExtension
->BaseAddress
, Dirql
);
199 if (!DeviceExtension
->BaseAddress
)
200 return STATUS_INSUFFICIENT_RESOURCES
;
202 return STATUS_INSUFFICIENT_RESOURCES
;
203 ComPortBase
= (PUCHAR
)DeviceExtension
->BaseAddress
;
205 if (DeviceExtension
->UartType
== UartUnknown
)
206 DeviceExtension
->UartType
= SerialDetectUartType(ComPortBase
);
208 /* Get current settings */
209 DeviceExtension
->MCR
= READ_PORT_UCHAR(SER_MCR(ComPortBase
));
210 DeviceExtension
->MSR
= READ_PORT_UCHAR(SER_MSR(ComPortBase
));
211 DeviceExtension
->WaitMask
= 0;
214 Status
= SerialSetBaudRate(DeviceExtension
, DeviceExtension
->BaudRate
);
215 if (!NT_SUCCESS(Status
))
217 DPRINT("Serial: SerialSetBaudRate() failed with status 0x%08x\n", Status
);
221 /* Set line control */
222 DeviceExtension
->SerialLineControl
.StopBits
= STOP_BIT_1
;
223 DeviceExtension
->SerialLineControl
.Parity
= NO_PARITY
;
224 DeviceExtension
->SerialLineControl
.WordLength
= 8;
225 Status
= SerialSetLineControl(DeviceExtension
, &DeviceExtension
->SerialLineControl
);
226 if (!NT_SUCCESS(Status
))
228 DPRINT("Serial: SerialSetLineControl() failed with status 0x%08x\n", Status
);
232 /* Clear receive/transmit buffers */
233 if (DeviceExtension
->UartType
>= Uart16550A
)
235 /* 16550 UARTs also have FIFO queues, but they are unusable due to a bug */
236 WRITE_PORT_UCHAR(SER_FCR(ComPortBase
),
237 SR_FCR_CLEAR_RCVR
| SR_FCR_CLEAR_XMIT
);
240 /* Create link \DosDevices\COMX -> \Device\SerialX */
241 swprintf(DeviceNameBuffer
, L
"\\Device\\Serial%lu", DeviceExtension
->SerialPortNumber
);
242 swprintf(LinkNameBuffer
, L
"\\DosDevices\\COM%lu", DeviceExtension
->ComPort
);
243 swprintf(ComPortBuffer
, L
"COM%lu", DeviceExtension
->ComPort
);
244 RtlInitUnicodeString(&DeviceName
, DeviceNameBuffer
);
245 RtlInitUnicodeString(&LinkName
, LinkNameBuffer
);
246 RtlInitUnicodeString(&ComPort
, ComPortBuffer
);
247 Status
= IoCreateSymbolicLink(&LinkName
, &DeviceName
);
248 if (!NT_SUCCESS(Status
))
250 DPRINT("Serial: IoCreateSymbolicLink() failed with status 0x%08x\n", Status
);
254 /* Connect interrupt and enable them */
255 Status
= IoConnectInterrupt(
256 &DeviceExtension
->Interrupt
, SerialInterruptService
,
258 Vector
, Dirql
, Dirql
,
259 InterruptMode
, ShareInterrupt
,
261 if (!NT_SUCCESS(Status
))
263 DPRINT("Serial: IoConnectInterrupt() failed with status 0x%08x\n", Status
);
264 IoDeleteSymbolicLink(&LinkName
);
268 /* Write an entry value under HKLM\HARDWARE\DeviceMap\SERIALCOMM */
269 /* This step is not mandatory, so don't exit in case of error */
270 RtlInitUnicodeString(&KeyName
, L
"\\Registry\\Machine\\HARDWARE\\DeviceMap\\SERIALCOMM");
271 InitializeObjectAttributes(&objectAttributes
, &KeyName
, OBJ_CASE_INSENSITIVE
, NULL
, NULL
);
272 Status
= ZwCreateKey(&hKey
, KEY_SET_VALUE
, &objectAttributes
, 0, NULL
, REG_OPTION_VOLATILE
, NULL
);
273 if (NT_SUCCESS(Status
))
275 /* Key = \Device\Serialx, Value = COMx */
276 ZwSetValueKey(hKey
, &DeviceName
, 0, REG_SZ
, &ComPortBuffer
, ComPort
.Length
+ sizeof(WCHAR
));
280 DeviceExtension
->PnpState
= dsStarted
;
282 /* Activate interrupt modes */
283 IER
= READ_PORT_UCHAR(SER_IER(ComPortBase
));
284 IER
|= SR_IER_DATA_RECEIVED
| SR_IER_THR_EMPTY
| SR_IER_LSR_CHANGE
| SR_IER_MSR_CHANGE
;
285 WRITE_PORT_UCHAR(SER_IER(ComPortBase
), IER
);
287 /* Activate DTR, RTS */
288 DeviceExtension
->MCR
|= SR_MCR_DTR
| SR_MCR_RTS
;
289 WRITE_PORT_UCHAR(SER_MCR(ComPortBase
), DeviceExtension
->MCR
);
291 return STATUS_SUCCESS
;
296 IN PDEVICE_OBJECT DeviceObject
,
300 PIO_STACK_LOCATION Stack
;
301 ULONG_PTR Information
= 0;
304 Stack
= IoGetCurrentIrpStackLocation(Irp
);
305 MinorFunction
= Stack
->MinorFunction
;
307 switch (MinorFunction
)
309 case IRP_MN_START_DEVICE
:
311 BOOLEAN ConflictDetected
;
312 DPRINT("Serial: IRP_MJ_PNP / IRP_MN_START_DEVICE\n");
314 /* FIXME: first HACK: PnP manager can send multiple
315 * IRP_MN_START_DEVICE for one device
317 if (((PSERIAL_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
)->PnpState
!= dsStopped
)
319 DPRINT1("Serial: device already started. Ignoring this irp!\n");
320 Status
= STATUS_SUCCESS
;
323 /* FIXME: second HACK: verify that we have some allocated resources.
324 * It seems not to be always the case on some hardware
326 if (Stack
->Parameters
.StartDevice
.AllocatedResources
== NULL
)
328 DPRINT1("Serial: no allocated resources. Can't start COM%lu\n",
329 ((PSERIAL_DEVICE_EXTENSION
)DeviceObject
->DeviceExtension
)->ComPort
);
330 Status
= STATUS_INSUFFICIENT_RESOURCES
;
333 /* FIXME: third HACK: verify that we don't have resource conflict,
334 * because PnP manager doesn't do it automatically
336 Status
= IoReportResourceForDetection(
337 DeviceObject
->DriverObject
, Stack
->Parameters
.StartDevice
.AllocatedResources
, 0,
340 if (!NT_SUCCESS(Status
))
342 Irp
->IoStatus
.Information
= 0;
343 Irp
->IoStatus
.Status
= Status
;
344 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
348 /* Call lower driver */
349 Status
= ForwardIrpAndWait(DeviceObject
, Irp
);
350 if (NT_SUCCESS(Status
))
351 Status
= SerialPnpStartDevice(
353 Stack
->Parameters
.StartDevice
.AllocatedResources
);
356 /* IRP_MN_QUERY_STOP_DEVICE (FIXME: required) */
357 /* IRP_MN_STOP_DEVICE (FIXME: required) */
358 /* IRP_MN_CANCEL_STOP_DEVICE (FIXME: required) */
359 /* IRP_MN_QUERY_REMOVE_DEVICE (FIXME: required) */
360 /* case IRP_MN_REMOVE_DEVICE (FIXME: required) */
362 DPRINT("Serial: IRP_MJ_PNP / IRP_MN_REMOVE_DEVICE\n");
364 IoReleaseRemoveLockAndWait
365 pass request to DeviceExtension-LowerDriver
366 IoDeleteDevice(Fdo) and/or IoDetachDevice
369 /* IRP_MN_CANCEL_REMOVE_DEVICE (FIXME: required) */
370 /* IRP_MN_SURPRISE_REMOVAL (FIXME: required) */
371 /* IRP_MN_QUERY_CAPABILITIES (optional) */
372 /* IRP_MN_QUERY_PNP_DEVICE_STATE (optional) */
373 /* IRP_MN_FILTER_RESOURCE_REQUIREMENTS (optional) */
374 /* IRP_MN_DEVICE_USAGE_NOTIFICATION (FIXME: required or optional ???) */
375 /* IRP_MN_QUERY_DEVICE_RELATIONS / BusRelations (optional) */
376 /* IRP_MN_QUERY_DEVICE_RELATIONS / RemovalRelations (optional) */
377 /* IRP_MN_QUERY_INTERFACE (optional) */
380 DPRINT1("Serial: unknown minor function 0x%x\n", MinorFunction
);
381 return ForwardIrpAndForget(DeviceObject
, Irp
);
385 Irp
->IoStatus
.Information
= Information
;
386 Irp
->IoStatus
.Status
= Status
;
387 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);