Programming element

Description

BatteryDrvrGetLevels

This function returns the number of levels that the battery driver is capable of returning in the BatteryFlag and BackupBatteryFlag members of the SYSTEM_POWER_STATUS_EX2 structure.

BatteryDrvrSupportsChangeNotification

This function indicates whether the battery driver can report whether the batteries were changed.

BatteryGetLifeTimeInfo

This function retrieves the time the user changed the batteries, the amount of time they used the batteries, and the amount of time they used the batteries before replacing them.

BatteryNotifyOfTimeChange

This function adjusts times to account for the user changing the real time.

BatteryPDDDeinitialize

This function allows the battery PDD to perform hardware-specific cleanup.

BatteryPDDGetLevels

This function indicates how many battery levels are reported in the BatteryFlag and BackupBatteryFlag members of the SYSTEM_POWER_STATUS_EX2 structure filled in by BatteryPDDGetStatus.

BatteryPDDGetStatus

This function obtains the most current battery and power status available on the platform. It fills in the structures pointed to by its parameters.

BatteryPDDInitialize

This function allows the battery PDD to perform hardware-specific initialization.

BatteryPDDPowerHandler

This power callback performs hardware-specific processing for the battery driver.

BatteryPDDResume

This function performs hardware-specific battery processing in a thread context following system resume.

BatteryPDDSupportsChangeNotification

This function indicates whether the battery driver can report whether the batteries were changed.

PFN_BATTERY_PDD_IOCONTROL

This function signature is for the battery driver custom IOCTL handler. It implements the optional PDD IOCTL interface.

IF BSP_NOBATTERY !

; HIVE BOOT SECTION

[HKEY_LOCAL_MACHINE/System/Events]

    "SYSTEM/BatteryAPIsReady"="Battery Interface APIs"

; END HIVE BOOT SECTION

; These registry entries load the battery driver.  The IClass value must match

; the BATTERY_DRIVER_CLASS definition in battery.h -- this is how the system

; knows which device is the battery driver.  Note that we are using

; DEVFLAGS_NAKEDENTRIES with this driver.  This tells the device manager

; to instantiate the device with the prefix named in the registry but to look

; for DLL entry points without the prefix.  For example, it will look for Init

; instead of BAT_Init.  This allows the prefix to be changed in the registry (if

; desired) without editing the driver code.

[HKEY_LOCAL_MACHINE/Drivers/BuiltIn/Battery]

   "Prefix"="BAT"

   "Dll"="battdrvr.dll"

   "Flags"=dword:8                      ; DEVFLAGS_NAKEDENTRIES

   "Order"=dword:0

   "IClass"="{DD176277-CD34-4980-91EE-67DBEF3D8913}"

ENDIF BSP_NOBATTERY !

Flag

Value

Description

DEVFLAGS_NONE

0x00000000

No flags are defined.

DEVFLAGS_UNLOAD

0x00000001

Driver unloads after a call to the XXX_Init entry point or after the XXX_Init entry point returns. No error code is returned.

Bus Enumerator typically runs with this flag.

DEVFLAGS_LOADLIBRARY

0x00000002

Driver is loaded with LoadLibrary instead of LoadDriver.

DEVFLAGS_NOLOAD

0x00000004

Driver is not loaded.

DEVFLAGS_NAKEDENTRIES

0x00000008

Driver entry points do not have a XXX Prefix prepended.

DEVFLAGS_BOOTPHASE_1

0x00001000

Driver is loaded during boot phase one. By default, device drivers are loaded during boot phase two.

Boot phase zero is before the Device Manager loads.

Boot phase one is to find the registry.

Boot phase two is when initial device drivers load.

Boot phase three is after initial device drivers load.

DEVFLAGS_IRQ_EXCLUSIVE

0x00000100

Driver loads only when it has exclusive access to the IRQ.

DEVFLAGS_TRUSTEDCALLERONLY

0x00010000

Driver can only be opened by a trusted application.

// This routine allocates a device driver structure in memory and initializes it.

// As part of this process, it loads the driver's DLL and obtains pointers to

// its entry points.  This routine returns a pointer to the new driver description

// structure, or NULL if there's an error.

static fsdev_t *

CreateDevice(

    LPCWSTR lpszPrefix,

    DWORD dwIndex,

    DWORD dwLegacyIndex,

    DWORD dwId,

    LPCWSTR lpszLib,

    DWORD dwFlags,

    LPCWSTR lpszBusPrefix,

    LPCWSTR lpszBusName,

    LPCWSTR lpszDeviceKey,

    HANDLE hParent

    )

{

    fsdev_t *lpdev;

    DWORD dwSize;

    DWORD dwStatus = ERROR_SUCCESS;

    WCHAR szDeviceName[MAXDEVICENAME];

    WCHAR szLegacyName[MAXDEVICENAME];

    DEBUGCHK(lpszPrefix != NULL);

    DEBUGCHK(lpszLib != NULL);

    DEBUGCHK(wcslen(lpszPrefix) <= 3);

    DEBUGCHK(dwLegacyIndex == dwIndex || (dwLegacyIndex == 0 && dwIndex == 10));

    DEBUGCHK(lpszBusName != NULL);

    // figure out how much memory to allocate

    dwSize = sizeof(*lpdev);

    // is the device named?

    if(lpszPrefix[0] == 0) {

        // unnamed device

        szDeviceName[0] = 0;

    } else {

        // named device, allocate room for its names

        StringCchPrintf(szDeviceName,MAXDEVICENAME,TEXT("%s%u"), lpszPrefix, dwIndex);

        if(dwLegacyIndex <= 9) {

            // allocate room for name and null

            StringCchPrintf(szLegacyName, MAXDEVICENAME, L"%s%u:", lpszPrefix, dwLegacyIndex);

            dwSize += (wcslen(szLegacyName) + 1) * sizeof(WCHAR);

        }

        // allocate room for name and null       

        dwSize += (wcslen(szDeviceName) + 1) * sizeof(WCHAR);

    }

    // If the bus driver didn't allocate a name the device may still support the

    // bus name interface -- use its device name (if present) just in case.

    if(lpszBusName[0] == 0 && szDeviceName[0] != 0) {

        lpszBusName = szDeviceName;

    }

    // allocate room for the bus name

    if(lpszBusName[0] != 0) {

        dwSize += (wcslen(lpszBusName) + 1) * sizeof(WCHAR);

    }

    // make room to store the device key as well

    if(lpszDeviceKey != NULL) {

        dwSize += (wcslen(lpszDeviceKey) + 1) * sizeof(WCHAR);

    }

    // allocate the structure

    if (!(lpdev = LocalAlloc(0, dwSize))) {

        DEBUGMSG(ZONE_WARNING, (_T("DEVICE!CreateDevice: couldn't allocate device structure/r/n")));

        dwStatus = ERROR_OUTOFMEMORY;

    } else {

        LPCWSTR pEffType = NULL;

        LPWSTR psz = (LPWSTR) (((LPBYTE) lpdev) + sizeof(*lpdev));

        memset(lpdev, 0, dwSize);

        lpdev->dwId = dwId;

        lpdev->wFlags = 0;           

        lpdev->dwFlags = dwFlags;

        if(PSLGetCallerTrust() == OEM_CERTIFY_TRUST) {

            lpdev->wFlags |= DF_TRUSTED_LOADER;

            lpdev->hParent = hParent;

        }

        if (lpszPrefix[0] != 0) {

            if(dwLegacyIndex <= 9) {

                lpdev->pszLegacyName = psz;

                wcscpy(lpdev->pszLegacyName, szLegacyName);

                psz += wcslen(lpdev->pszLegacyName) + 1;

            }

            lpdev->pszDeviceName = psz;

            wcscpy(lpdev->pszDeviceName, szDeviceName);

            psz += wcslen(lpdev->pszDeviceName) + 1;

        }

        if(lpszBusName[0] != 0) {

            lpdev->pszBusName = psz;

            wcscpy(lpdev->pszBusName, lpszBusName);

            psz += wcslen(lpszBusName) + 1;

        }

        if(lpszDeviceKey != NULL) {

            lpdev->pszDeviceKey= psz;

            wcscpy(lpdev->pszDeviceKey, lpszDeviceKey);

            psz += wcslen(lpszDeviceKey) + 1;

        }

        if((dwFlags & DEVFLAGS_NAKEDENTRIES) == 0) {

            if(lpszPrefix[0] != 0) {

                DEBUGCHK(lpszBusPrefix[0] == 0 || wcsicmp(lpszBusPrefix, lpszPrefix) == 0);

                pEffType = lpszPrefix;      // use standard prefix decoration

            } else if(lpszBusPrefix[0] != 0 && lpdev->pszBusName != NULL) {

                pEffType = lpszBusPrefix;   // no standard prefix, use bus prefix decoration

            } else {

                if(lpdev->pszDeviceName != NULL) {

                    // device is expected to have a device or bus name, but we don't know

                    // how to look for its entry points

                    DEBUGMSG(ZONE_ACTIVE || ZONE_ERROR,

                        (_T("DEVICE!CreateDevice: no entry point information for '%s' can't load '%s'/r/n"),

                        lpszLib, lpdev->pszDeviceName));

                    dwStatus = ERROR_INVALID_FUNCTION;

                }

            }

        }

        // 这里会去判断”Flags”的值，决定是否使用Prefix

        if ((dwFlags & DEVFLAGS_LOAD_AS_USERPROC)) {

            lpdev->hLib = NULL;

            lpdev->dwData  = Reflector_Create(lpszDeviceKey, pEffType, lpszLib, dwFlags );

            if (lpdev->dwData != 0 ) {

                lpdev->fnInit = NULL;

                lpdev->fnInitEx = (pInitExFn)Reflector_InitEx;

                lpdev->fnPreDeinit = (pDeinitFn)Reflector_PreDeinit;

                lpdev->fnDeinit = (pDeinitFn)Reflector_Deinit;

                lpdev->fnOpen = (pOpenFn)Reflector_Open;

                lpdev->fnPreClose = (pCloseFn)Reflector_PreClose;

                lpdev->fnClose = (pCloseFn)Reflector_Close;

                lpdev->fnRead = (pReadFn)Reflector_Read;

                lpdev->fnWrite = (pWriteFn)Reflector_Write;

                lpdev->fnSeek = (pSeekFn)Reflector_SeekFn;

                lpdev->fnControl = (pControlFn)Reflector_Control;

                lpdev->fnPowerup = (pPowerupFn)Reflector_Powerup;

                lpdev->fnPowerdn = (pPowerupFn)Reflector_Powerdn;

            }

            else {

                DEBUGMSG(ZONE_WARNING, (_T("DEVICE!CreateDevice: couldn't load(%s) to user mode!!/r/n"),lpszLib));

                dwStatus = ERROR_FILE_NOT_FOUND;

            }

        }

        else {

            DEBUGMSG(ZONE_ACTIVE, (_T("DEVICE!CreateDevice: loading driver DLL '%s'/r/n"), lpszLib));

            // 这里去判断的如何去加载Stream Driver，其实这里最终会影响到驱动DLL需要的内存的Page-in和page-out，这些不是这里要说的重点，暂且不说

            lpdev->hLib =

                (dwFlags & DEVFLAGS_LOADLIBRARY) ? LoadLibrary(lpszLib) : LoadDriver(lpszLib);

            if (!lpdev->hLib) {

                DEBUGMSG(ZONE_WARNING, (_T("DEVICE!CreateDevice: couldn't load '%s' -- error %d/r/n"),

                    lpszLib, GetLastError()));

                dwStatus = ERROR_FILE_NOT_FOUND;

            } else {

                // 最终如果配置为0x08，程序将会走到这里

                lpdev->fnInitEx = NULL;

                lpdev->fnInit = (pInitFn)GetDMProcAddr(pEffType,L"Init",lpdev->hLib);

                lpdev->fnPreDeinit = (pDeinitFn)GetDMProcAddr(pEffType,L"PreDeinit",lpdev->hLib);

                lpdev->fnDeinit = (pDeinitFn)GetDMProcAddr(pEffType,L"Deinit",lpdev->hLib);

                lpdev->fnOpen = (pOpenFn)GetDMProcAddr(pEffType,L"Open",lpdev->hLib);

                lpdev->fnPreClose = (pCloseFn)GetDMProcAddr(pEffType,L"PreClose",lpdev->hLib);

                lpdev->fnClose = (pCloseFn)GetDMProcAddr(pEffType,L"Close",lpdev->hLib);

                lpdev->fnRead = (pReadFn)GetDMProcAddr(pEffType,L"Read",lpdev->hLib);

                lpdev->fnWrite = (pWriteFn)GetDMProcAddr(pEffType,L"Write",lpdev->hLib);

                lpdev->fnSeek = (pSeekFn)GetDMProcAddr(pEffType,L"Seek",lpdev->hLib);

                lpdev->fnControl = (pControlFn)GetDMProcAddr(pEffType,L"IOControl",lpdev->hLib);

                lpdev->fnPowerup = (pPowerupFn)GetDMProcAddr(pEffType,L"PowerUp",lpdev->hLib);

                lpdev->fnPowerdn = (pPowerdnFn)GetDMProcAddr(pEffType,L"PowerDown",lpdev->hLib);

                // Make sure that the driver has an init and deinit routine.  If it is named,

                // it must have open and close, plus at least one of the I/O routines (read, write

                // ioctl, and/or seek).  If a named driver has a pre-close routine, it must also

                // have a pre-deinit routine.

                if (!(lpdev->fnInit && lpdev->fnDeinit) ||

                    lpdev->pszDeviceName != NULL && (!lpdev->fnOpen ||

                                 !lpdev->fnClose ||

                                 (!lpdev->fnRead && !lpdev->fnWrite &&

                                  !lpdev->fnSeek && !lpdev->fnControl) ||

                                 (lpdev->fnPreClose && !lpdev->fnPreDeinit))) {

                    DEBUGMSG(ZONE_WARNING, (_T("DEVICE!CreateDevice: illegal entry point combination in driver DLL '%s'/r/n"),

                        lpszLib));

                    dwStatus = ERROR_INVALID_FUNCTION;

                }

                if (!lpdev->fnOpen) lpdev->fnOpen = (pOpenFn) DevFileNotSupportedBool;

                if (!lpdev->fnClose) lpdev->fnClose = (pCloseFn) DevFileNotSupportedBool;

                if (!lpdev->fnControl) lpdev->fnControl = (pControlFn) DevFileNotSupportedBool;

                if (!lpdev->fnRead) lpdev->fnRead = (pReadFn) DevFileNotSupportedDword;

                if (!lpdev->fnWrite) lpdev->fnWrite = (pWriteFn) DevFileNotSupportedDword;

                if (!lpdev->fnSeek) lpdev->fnSeek = (pSeekFn) DevFileNotSupportedDword;

            }

        }

    }

    // did everything go ok?

    if(dwStatus != ERROR_SUCCESS) {

        if(lpdev != NULL) {

            DeleteDevice(lpdev);

            lpdev = NULL;

        }

        SetLastError(dwStatus);

    }

    DEBUGMSG(ZONE_ACTIVE || (dwStatus != ERROR_SUCCESS && ZONE_WARNING),

        (_T("CreateDevice: creation of type '%s', index %d, lib '%s' returning 0x%08x, error code %d/r/n"),

        lpszPrefix[0] != 0 ? lpszPrefix : _T("<unnamed>"), dwIndex, lpszLib, lpdev, dwStatus));

    return lpdev;

}

//

// This routine is security check for dwInfo passed in by either RegistryDevice or ActiveDevice

DWORD CheckLauchDeviceParam(DWORD dwInfo)

{

    if (CeGetCallerTrust() != OEM_CERTIFY_TRUST) { // Untrusted caller will do following.

        LPCTSTR lpActivePath = (LPCTSTR) dwInfo; // We assume it is Registry Path.

        if (lpActivePath) {

            HKEY hActiveKey;

            if (RegOpenKeyEx( HKEY_LOCAL_MACHINE, lpActivePath, 0, 0, &hActiveKey) == ERROR_SUCCESS ) { // It is registry.

                // We need check Registry is in secure location.

                CE_REGISTRY_INFO regInfo;

                DWORD dwRet = ERROR_INVALID_PARAMETER;

                memset(&regInfo,0,sizeof(regInfo));

                regInfo.cbSize = sizeof(CE_REGISTRY_INFO);

                if (CeFsIoControl(NULL, FSCTL_GET_REGISTRY_INFO, &hActiveKey, sizeof(HKEY), &regInfo, sizeof(CE_REGISTRY_INFO), NULL, NULL)) { // Succeed

                    if (regInfo.dwFlags & CE_REG_INFO_FLAG_TRUST_PROTECTED) {

                        dwRet = ERROR_SUCCESS;

                    }

                }

                RegCloseKey( hActiveKey );

                return dwRet;

            }

        }

    }

    return ERROR_SUCCESS; 

}

#define DEF_BATTERYPOLLTIMEOUT          500         // in milliseconds

// 5 Seconds for average delay of 2.5 seconds

#define DEF_BATTERYPOLLTIMEOUT          (5*1000)         // in milliseconds

[HKEY_LOCAL_MACHINE/Drivers/BuiltIn/Battery]

"Prefix"="BAT"

"Dll"="battdrvr.dll"

"Flags"=dword:8                      ; DEVFLAGS_NAKEDENTRIES

"Order"=dword:45

"IClass"="{DD176277-CD34-4980-91EE-67DBEF3D8913}"

"PollInterval"=dword:1388