los_driverbase.h

浏览该文件的文档.

/* ---------------------------------------------------------------------------
 * Copyright (c) Huawei Technologies Co., Ltd. 2020-2020. All rights reserved.
 * Description: Driver Framework Header File
 * Author: Huawei LiteOS Team
 * Create: 2020-08-15
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
 * of conditions and the following disclaimer in the documentation and/or other materials
 * provided with the distribution.
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific prior written
 * permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * --------------------------------------------------------------------------- */
 
#ifndef _LOS_DRIVER_BASE_H
#define _LOS_DRIVER_BASE_H
 
#include "los_mux.h"
 
struct LosDriver;
extern LOS_DL_LIST g_deviceList;
 
struct LosDeviceRegs {
    UINTPTR base; 
    UINTPTR size; 
};
 
struct LosDeviceConfig {
    UINTPTR irqNum;             
    UINT32 numRegs;             
    struct LosDeviceRegs *regs; 
};
 
struct LosDevice {
    const CHAR *name;           
    INT32 id;                   
    LOS_DL_LIST driverNode;     
    LOS_DL_LIST deviceItem;     
    LOS_DL_LIST pmNode;         
    UINT32 mutex;               
    BOOL isRegistered;          
    struct LosDriver *driver;   
    struct LosDeviceConfig cfg; 
    VOID *data;                 
};
 
struct LosPowerMgrOps {
    INT32 (*suspend)(struct LosDevice *device);  
    INT32 (*resume)(struct LosDevice *device);   
    INT32 (*prepare)(struct LosDevice *device);  
    INT32 (*complete)(struct LosDevice *device); 
};
 
struct LosDriverOps {
    INT32 (*probe)(struct LosDevice *device);   
    INT32 (*remove)(struct LosDevice *device);  
    VOID (*shutdown)(struct LosDevice *device); 
};
 
struct LosDriver {
    const CHAR *name;            
    LOS_DL_LIST deviceList;      
    LOS_DL_LIST driverItem;      
    UINT32 mutex;                
    BOOL isRegistered;           
    struct LosDriverOps ops;     
    struct LosPowerMgrOps pmOps; 
};
 
/* errno */
#define LOS_ERRNO_DRIVER_INPUT_INVALID                        LOS_ERRNO_OS_ERROR(LOS_MOD_DRIVER, 0x10)
 
#define LOS_ERRNO_DRIVER_MUX_FAIL                             LOS_ERRNO_OS_ERROR(LOS_MOD_DRIVER, 0x11)
 
#define LOS_ERRNO_DRIVER_DRIVER_MATCH_FAIL                    LOS_ERRNO_OS_ERROR(LOS_MOD_DRIVER, 0x20)
 
#define LOS_ERRNO_DRIVER_DRIVER_PROBE_FAIL                    LOS_ERRNO_OS_ERROR(LOS_MOD_DRIVER, 0x21)
 
#define LOS_ERRNO_DRIVER_DRIVER_REGISTERED                    LOS_ERRNO_OS_ERROR(LOS_MOD_DRIVER, 0x22)
 
#define LOS_ERRNO_DRIVER_DRIVER_NOTFOUND                      LOS_ERRNO_OS_ERROR(LOS_MOD_DRIVER, 0x23)
 
#define LOS_ERRNO_DRIVER_DEVICE_BOUNDED                       LOS_ERRNO_OS_ERROR(LOS_MOD_DRIVER, 0x30)
 
#define LOS_ERRNO_DRIVER_DEVICE_INITIALFAIL                   LOS_ERRNO_OS_ERROR(LOS_MOD_DRIVER, 0x31)
 
#define LOS_ERRNO_DRIVER_DEVICE_REGISTERED                    LOS_ERRNO_OS_ERROR(LOS_MOD_DRIVER, 0x32)
 
#define LOS_ERRNO_DRIVER_DEVICE_BUSY                          LOS_ERRNO_OS_ERROR(LOS_MOD_DRIVER, 0x33)
 
/* driver api */
UINT32 LOS_DriverRegister(struct LosDriver *drv);
 
UINT32 LOS_DriverUnregister(struct LosDriver *drv);
 
/* device api */
UINT32 LOS_DeviceRegister(struct LosDevice *dev);
 
void LOS_DeviceUnregister(struct LosDevice *dev);
 
VOID *LOS_DeviceDataGet(const struct LosDevice *dev);
 
UINTPTR LOS_DeviceRegBaseGet(const struct LosDevice *dev, UINT32 index);
 
UINTPTR LOS_DeviceRegSizeGet(const struct LosDevice *dev, UINT32 index);
 
UINTPTR LOS_DeviceIrqNumGet(const struct LosDevice *dev);
 
INT32 LOS_PmSuspend(VOID);
 
VOID LOS_PmResume(VOID);
 
#define LOS_FOREACH_DEVICE_LIST_HOOK(device, list, hook) \
    LOS_DL_LIST_FOR_EACH_ENTRY_HOOK(device, list, struct LosDevice, driverNode, hook)
 
#define LOS_FOREACH_DEVICE_HOOK(device, hook) \
    LOS_DL_LIST_FOR_EACH_ENTRY_HOOK(device, &g_deviceList, struct LosDevice, deviceItem, hook)
 
#define LOS_FOREACH_DEVICE_BY_DRIVER(device, driver) \
    LOS_FOREACH_DEVICE_LIST_HOOK(device, &(driver)->deviceList, NULL)
 
#define LOS_FOREACH_DEVICE(device) \
    LOS_FOREACH_DEVICE_HOOK(device, NULL)
 
#endif