scsi_driver_extensions.h

/*
 * Copyright (c) 2019 SUSE LLC
 *
 * Licensed under LGPL-2.1 (see LICENSE)
 */

#ifndef SCSI_DRIVER_EXTENSIONS_H
#define SCSI_DRIVER_EXTENSIONS_H 1

#include "common.h"
#include "wnbd_ioctl.h"

typedef struct _WNBD_EXTENSION {
    UNICODE_STRING                    DeviceInterface;
    LIST_ENTRY                        DeviceList;
    KSPIN_LOCK                        DeviceListLock;
    LONG                              DeviceCount;
    ERESOURCE                         DeviceCreationLock;

    EX_RUNDOWN_REF                    RundownProtection;
    KEVENT                            GlobalDeviceRemovalEvent;
} WNBD_EXTENSION, *PWNBD_EXTENSION;

typedef struct _WNBD_DISK_DEVICE
{
    LIST_ENTRY                  ListEntry;
    PWNBD_EXTENSION             DeviceExtension;

    BOOLEAN                     Connected;
    WNBD_PROPERTIES             Properties;
    WNBD_CONNECTION_ID          ConnectionId;

    USHORT                      Bus;
    USHORT                      Target;
    USHORT                      Lun;

    INT                         DiskNumber;
    WCHAR                       PNPDeviceID[WNBD_MAX_NAME_LENGTH];
    PDEVICE_OBJECT              PDO;

    PINQUIRYDATA                InquiryData;

    LIST_ENTRY                  PendingReqListHead;
    KSPIN_LOCK                  PendingReqListLock;

    LIST_ENTRY                  SubmittedReqListHead;
    KSPIN_LOCK                  SubmittedReqListLock;

    KSEMAPHORE                  DeviceEvent;
    PVOID                       DeviceMonitorThread;
    BOOLEAN                     HardRemoveDevice;
    KEVENT                      DeviceRemovalEvent;
    // The rundown protection provides device reference counting, preventing
    // it from being deallocated while still being accessed. This is
    // especially important for IO dispatching.
    EX_RUNDOWN_REF              RundownProtection;

    WNBD_DRV_STATS              Stats;
} WNBD_DISK_DEVICE, *PWNBD_DISK_DEVICE;

typedef struct _SRB_QUEUE_ELEMENT {
    LIST_ENTRY Link;
    PVOID Srb;
    UINT64 StartingLbn;
    ULONG DataLength;
    BOOLEAN FUA;
    PVOID DeviceExtension;
    UINT64 Tag;
    BOOLEAN Aborted;
    BOOLEAN Completed;
    // Retrieved using KeQueryInterruptTime.
    UINT64 ReqTimestamp;
} SRB_QUEUE_ELEMENT, * PSRB_QUEUE_ELEMENT;

SCSI_ADAPTER_CONTROL_STATUS
WnbdHwAdapterControl(_In_ PVOID DeviceExtension,
                     _In_ SCSI_ADAPTER_CONTROL_TYPE ControlType,
                     _In_ PVOID Parameters);

ULONG
WnbdHwFindAdapter(_In_ PVOID DeviceExtension,
                  _In_ PVOID HwContext,
                  _In_ PVOID BusInformation,
                  _In_ PVOID LowerDevice,
                  _In_ PCHAR ArgumentString,
                  _Inout_ PPORT_CONFIGURATION_INFORMATION ConfigInfo,
                  _In_ PBOOLEAN Again);

VOID
WnbdHwFreeAdapterResources(_In_ PVOID DeviceExtension);

BOOLEAN
WnbdHwInitialize(_In_ PVOID DeviceExtension);

VOID
WnbdHwProcessServiceRequest(_In_ PVOID DeviceExtension,
                            _In_ PVOID Irp);

BOOLEAN
WnbdHwResetBus(_In_ PVOID DeviceExtension,
               _In_ ULONG PathId);

BOOLEAN
WnbdHwStartIo(_In_ PVOID PDevExt,
              _In_ PVOID PSrb);

#endif