host/src/ddk_device_manager.c

/*
 * Copyright (c) 2022-2023 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "ddk_device_manager.h"

#include <ctype.h>
#include <dirent.h>
#include <fcntl.h>
#include <unistd.h>

#include "ddk_sysfs_device.h"
#include "hdf_base.h"
#include "hdf_dlist.h"
#include "hdf_io_service_if.h"
#include "hdf_log.h"
#include "hdf_sbuf.h"
#include "osal_mem.h"
#include "osal_mutex.h"
#include "securec.h"
#include "usbd_wrapper.h"

#define HDF_LOG_TAG usb_ddk_dev_mgr
#define USB_GADGET_STATE_PATH "/sys/devices/virtual/"
struct UsbDdkDeviceInfo {
    struct OsalMutex deviceMutex;
    struct DListHead list;
    struct UsbPnpNotifyMatchInfoTable info;
};

struct UsbDdkDeviceList {
    bool isInit;
    struct OsalMutex listMutex;
    struct DListHead devList;
};

#ifdef USB_EVENT_NOTIFY_LINUX_NATIVE_MODE
static struct UsbDdkDeviceList g_ddkDevList = {.isInit = false};
#define STATE_STRING_LENGTH 20

char *g_gadgetStatePath = "invalid_path";

static struct UsbDdkDeviceInfo *DdkDevMgrIsDevExists(uint64_t devAddr)
{
    OsalMutexLock(&g_ddkDevList.listMutex);
    if (DListIsEmpty(&g_ddkDevList.devList)) {
        HDF_LOGI("%{public}s: the devList is empty.", __func__);
        OsalMutexUnlock(&g_ddkDevList.listMutex);
        return NULL;
    }

    struct UsbDdkDeviceInfo *res = NULL;
    struct UsbDdkDeviceInfo *infoPos = NULL;
    struct UsbDdkDeviceInfo *infoTemp = NULL;
    DLIST_FOR_EACH_ENTRY_SAFE(infoPos, infoTemp, &g_ddkDevList.devList, struct UsbDdkDeviceInfo, list) {
        if (infoPos->info.usbDevAddr == devAddr) {
            res = infoPos;
            break;
        }
    }
    OsalMutexUnlock(&g_ddkDevList.listMutex);
    return res;
}

static int32_t DdkDevMgrAddDevice(struct UsbDdkDeviceInfo *device)
{
    if (device == NULL) {
        HDF_LOGE("%{public}s: invalid param", __func__);
        return HDF_ERR_INVALID_PARAM;
    }

    HDF_LOGI("%{public}s: make device address and whether the device exists", __func__);
    if (DdkDevMgrIsDevExists(DdkSysfsMakeDevAddr(device->info.busNum, device->info.devNum)) != NULL) {
        HDF_LOGW("%{public}s: add device repeatedly busNum:%{public}d, devNum:%{public}d", __func__,
            device->info.busNum, device->info.devNum);
        return HDF_SUCCESS;
    }

    OsalMutexLock(&g_ddkDevList.listMutex);
    DListInsertTail(&device->list, &g_ddkDevList.devList);
    OsalMutexUnlock(&g_ddkDevList.listMutex);
    HDF_LOGI("%{public}s: add device successed", __func__);
    return HDF_SUCCESS;
}

int32_t DdkDevMgrRemoveDevice(int32_t busNum, int32_t devNum, struct UsbPnpNotifyMatchInfoTable *info)
{
    uint64_t devAddr = DdkSysfsMakeDevAddr(busNum, devNum);
    struct UsbDdkDeviceInfo *dev = DdkDevMgrIsDevExists(devAddr);
    if (dev == NULL) {
        HDF_LOGE("%{public}s: no device busNum:%{public}d, devNum:%{public}d", __func__, busNum, devNum);
        return HDF_DEV_ERR_NO_DEVICE;
    }

    int32_t ret = memcpy_s(
        info, sizeof(struct UsbPnpNotifyMatchInfoTable), &dev->info, sizeof(struct UsbPnpNotifyMatchInfoTable));
    if (ret != EOK) {
        HDF_LOGE("%{public}s: memcpy_s failed", __func__);
        return HDF_FAILURE;
    }

    OsalMutexLock(&g_ddkDevList.listMutex);
    if (dev->list.prev != NULL && dev->list.next != NULL) {
        DListRemove(&dev->list);
    } else {
        HDF_LOGE("%{public}s: The node prev or next is NULL", __func__);
    }
    OsalMemFree(dev);
    dev = NULL;
    OsalMutexUnlock(&g_ddkDevList.listMutex);
    return HDF_SUCCESS;
}

static int32_t DdkDevMgrInitDevice(struct UsbDdkDeviceInfo *deviceInfo)
{
    (void)memset_s(deviceInfo, sizeof(struct UsbDdkDeviceInfo), 0, sizeof(struct UsbDdkDeviceInfo));
    int32_t ret = OsalMutexInit(&deviceInfo->deviceMutex);
    if (ret != HDF_SUCCESS) {
        HDF_LOGE("%{public}s: init mutex failed", __func__);
        return HDF_FAILURE;
    }
    DListHeadInit(&deviceInfo->list);

    return HDF_SUCCESS;
}

const struct UsbPnpNotifyMatchInfoTable *DdkDevMgrCreateDevice(const char *deviceDir)
{
    struct UsbDdkDeviceInfo *device = (struct UsbDdkDeviceInfo *)OsalMemCalloc(sizeof(struct UsbDdkDeviceInfo));
    if (device == NULL) {
        HDF_LOGE("%{public}s: init device failed", __func__);
        return NULL;
    }

    int32_t status = HDF_SUCCESS;
    do {
        // init device
        status = DdkDevMgrInitDevice(device);
        if (status != HDF_SUCCESS) {
            HDF_LOGE("%{public}s: init device failed:%{public}d", __func__, status);
            break;
        }

        // get device from sysfs
        status = DdkSysfsGetDevice(deviceDir, &device->info);
        if (status != HDF_SUCCESS) {
            HDF_LOGE("%{public}s: sysfs get device failed:%{public}d", __func__, status);
            break;
        }

        // insert device to list
        status = DdkDevMgrAddDevice(device);
        if (status != HDF_SUCCESS) {
            HDF_LOGE("%{public}s: add device failed:%{public}d", __func__, status);
            break;
        }
        return &device->info;
    } while (0);

    OsalMemFree(device);
    return status == HDF_SUCCESS ? &device->info : NULL;
}

static int32_t DdkDevMgrScanSysfs(const char *sysfsDevDir)
{
    if (sysfsDevDir == NULL) {
        HDF_LOGE("%{public}s: invalid param", __func__);
        return HDF_ERR_INVALID_PARAM;
    }

    DIR *dir = opendir(sysfsDevDir);
    if (dir == NULL) {
        HDF_LOGE("%{public}s: opendir failed sysfsDevDir:%{public}s", __func__, sysfsDevDir);
        return HDF_ERR_BAD_FD;
    }

    struct dirent *devHandle;
    while ((devHandle = readdir(dir))) {
        // only read dir like 3-1
        if (devHandle->d_name[0] > '9' || devHandle->d_name[0] < '0' || strchr(devHandle->d_name, ':')) {
            continue;
        }

        if (DdkDevMgrCreateDevice(devHandle->d_name) == NULL) {
            HDF_LOGW("%{public}s: create device failed d_name:%{public}s", __func__, devHandle->d_name);
        }
    }
    closedir(dir);
    return HDF_SUCCESS;
}

int32_t DdkDevMgrInit(const char *gadgetStatePath)
{
    if (g_ddkDevList.isInit) {
        return HDF_SUCCESS;
    }

    if (gadgetStatePath == NULL) {
        HDF_LOGE("%{public}s: invalid gadgetStatePath", __func__);
        return HDF_ERR_INVALID_PARAM;
    }

    g_gadgetStatePath = (char *)gadgetStatePath;
    int32_t ret = OsalMutexInit(&g_ddkDevList.listMutex);
    if (ret != HDF_SUCCESS) {
        HDF_LOGE("%{public}s: init mutex failed", __func__);
        return HDF_FAILURE;
    }

    DListHeadInit(&g_ddkDevList.devList);
    ret = DdkDevMgrScanSysfs(SYSFS_DEVICES_DIR);
    if (ret != HDF_SUCCESS) {
        HDF_LOGE("%{public}s: Scan sysfs failed ret=%{public}d", __func__, ret);
        return HDF_FAILURE;
    }
    g_ddkDevList.isInit = true;
    return HDF_SUCCESS;
}

int32_t DdkDevMgrForEachDeviceSafe(DdkDevMgrHandleDev handle, void *priv)
{
    OsalMutexLock(&g_ddkDevList.listMutex);
    if (DListIsEmpty(&g_ddkDevList.devList)) {
        HDF_LOGI("%{public}s:the devList is empty", __func__);
        OsalMutexUnlock(&g_ddkDevList.listMutex);
        return HDF_SUCCESS;
    }

    struct UsbDdkDeviceInfo *pos = NULL;
    struct UsbDdkDeviceInfo *tmp = NULL;
    DLIST_FOR_EACH_ENTRY_SAFE(pos, tmp, &g_ddkDevList.devList, struct UsbDdkDeviceInfo, list) {
        if (handle(&pos->info, priv) != HDF_SUCCESS) {
            HDF_LOGW("%{public}s: handle failed", __func__);
        }
    }

    OsalMutexUnlock(&g_ddkDevList.listMutex);
    return HDF_SUCCESS;
}

int32_t DdkDevMgrGetGadgetLinkStatusSafe(DdkDevMgrHandleGadget handle, void *priv)
{
    if (priv == NULL || handle == NULL) {
        HDF_LOGE("%{public}s: invalid param.", __func__);
        return HDF_ERR_INVALID_OBJECT;
    }

    char pathBuf[PATH_MAX] = {'\0'};
    if (realpath(g_gadgetStatePath, pathBuf) == NULL) {
        HDF_LOGE("%{public}s: path conversion failed", __func__);
        return HDF_FAILURE;
    }

    if (strncmp(USB_GADGET_STATE_PATH, pathBuf, strlen(USB_GADGET_STATE_PATH)) != 0) {
        HDF_LOGE("%{public}s: The file path is incorrect", __func__);
        return HDF_FAILURE;
    }

    int32_t fd = open(pathBuf, O_RDONLY | O_CLOEXEC);
    if (fd == -1) {
        HDF_LOGE("%{public}s: open %{public}s failed  errno:%{public}d", __func__, g_gadgetStatePath, errno);
        return HDF_ERR_IO;
    }

    char buf[STATE_STRING_LENGTH] = {0};
    ssize_t numRead = read(fd, buf, STATE_STRING_LENGTH);
    close(fd);
    if (numRead <= 0) {
        HDF_LOGE("%{public}s: read state failed errno:%{public}d", __func__, errno);
        return HDF_ERR_IO;
    }

    if ((strncmp(buf, "CONNECTED", strlen("CONNECTED")) == 0) ||
        (strncmp(buf, "CONFIGURED", strlen("CONFIGURED")) == 0)) {
        // call back
        if (handle(priv) != HDF_SUCCESS) {
            HDF_LOGW("%{public}s: handle failed", __func__);
        }
    }

    return HDF_SUCCESS;
}
bool DdkDevMgrGetGadgetLinkStatus()
{
    char pathBuf[PATH_MAX] = {'\0'};
    if (realpath(g_gadgetStatePath, pathBuf) == NULL) {
        HDF_LOGE("%{public}s: path conversion failed", __func__);
        return false;
    }

    if (strncmp(USB_GADGET_STATE_PATH, pathBuf, strlen(USB_GADGET_STATE_PATH)) != 0) {
        HDF_LOGE("%{public}s: The file path is incorrect", __func__);
        return false;
    }

    int32_t fd = open(pathBuf, O_RDONLY | O_CLOEXEC);
    if (fd == -1) {
        HDF_LOGE("%{public}s: open %{public}s failed  errno:%{public}d", __func__, g_gadgetStatePath, errno);
        return false;
    }

    char buf[STATE_STRING_LENGTH] = {0};
    ssize_t numRead = read(fd, buf, STATE_STRING_LENGTH);
    close(fd);
    if (numRead <= 0) {
        HDF_LOGE("%{public}s: read state failed errno:%{public}d", __func__, errno);
        return false;
    }
    HDF_LOGE("%{public}s: read status:%{public}s", __func__, buf);
    if ((strncmp(buf, "CONNECTED", strlen("CONNECTED")) == 0) ||
        (strncmp(buf, "CONFIGURED", strlen("CONFIGURED")) == 0)) {
        return true;
    }
    return false;
}
#else                                                                           // USB_EVENT_NOTIFY_LINUX_NATIVE_MODE
struct HdfIoService *g_usbPnpSrv = NULL;
#define HDF_USB_INFO_MAX_SIZE (127 * sizeof(struct UsbPnpNotifyMatchInfoTable)) // 127  is max deivce num
int32_t DdkDevMgrInit(const char *gadgetStatePath)
{
    (void)gadgetStatePath;
    g_usbPnpSrv = HdfIoServiceBind(USB_PNP_NOTIFY_SERVICE_NAME);
    if (g_usbPnpSrv == NULL) {
        HDF_LOGE("%{public}s: HdfIoServiceBind failed.", __func__);
        return HDF_ERR_INVALID_OBJECT;
    }
    return HDF_SUCCESS;
}

int32_t DdkDevMgrForEachDeviceSafe(DdkDevMgrHandleDev handle, void *priv)
{
    if (g_usbPnpSrv == NULL || handle == NULL) {
        HDF_LOGE("%{public}s: invalid param.", __func__);
        return HDF_ERR_INVALID_OBJECT;
    }

    struct HdfSBuf *reply = HdfSbufObtain(HDF_USB_INFO_MAX_SIZE);
    if (reply == NULL) {
        HDF_LOGE("%{public}s: HdfSbufObtain reply failed", __func__);
        return HDF_DEV_ERR_NO_MEMORY;
    }

    // request device list from pnp service
    int32_t ret = g_usbPnpSrv->dispatcher->Dispatch(&g_usbPnpSrv->object, USB_PNP_DRIVER_GETDEVICES, NULL, reply);
    if (ret != HDF_SUCCESS) {
        HDF_LOGE("%{public}s:failed to send service call, ret:%{public}d", __func__, ret);
        HdfSbufRecycle(reply);
        return ret;
    }

    // read device list
    int32_t count = 0;
    if (!HdfSbufReadInt32(reply, &count)) {
        HDF_LOGE("%{public}s: failed to read count from reply", __func__);
        HdfSbufRecycle(reply);
        return HDF_ERR_INVALID_PARAM;
    }

    HDF_LOGI("%{public}s: total obj num count:%{public}d ", __func__, count);
    struct UsbPnpNotifyMatchInfoTable *info = NULL;
    uint32_t infoSize = 0;
    for (int32_t i = 0; i < count; ++i) {
        if (!HdfSbufReadBuffer(reply, (const void **)(&info), &infoSize) || info == NULL) {
            HDF_LOGE("%{public}s: HdfSbufReadBuffer failed", __func__);
            HdfSbufRecycle(reply);
            return HDF_ERR_INVALID_PARAM;
        }
        // call back
        if (handle(info, priv) != HDF_SUCCESS) {
            HDF_LOGW("%{public}s: handle failed", __func__);
        }
    }

    HdfSbufRecycle(reply);
    return HDF_SUCCESS;
}

static int32_t DdkDevMgrGetGadgetStatus(int32_t *gadgetStatus)
{
    if (g_usbPnpSrv == NULL) {
        HDF_LOGE("%{public}s: invalid param.", __func__);
        return HDF_ERR_INVALID_OBJECT;
    }

    struct HdfSBuf *reply = HdfSbufObtain(HDF_USB_INFO_MAX_SIZE);
    if (reply == NULL) {
        HDF_LOGE("%{public}s: HdfSbufObtain reply failed", __func__);
        return HDF_DEV_ERR_NO_MEMORY;
    }

    int32_t ret =
        g_usbPnpSrv->dispatcher->Dispatch(&g_usbPnpSrv->object, USB_PNP_DRIVER_GET_GADGET_LINK_STATUS, NULL, reply);
    if (ret != HDF_SUCCESS) {
        HDF_LOGE("%{public}s:failed to send service call, ret:%{public}d", __func__, ret);
        HdfSbufRecycle(reply);
        return ret;
    }

    if (!HdfSbufReadInt32(reply, gadgetStatus)) {
        HDF_LOGE("%{public}s: failed to read count from reply", __func__);
        HdfSbufRecycle(reply);
        return HDF_ERR_INVALID_PARAM;
    }

    HdfSbufRecycle(reply);
    return HDF_SUCCESS;
}

int32_t DdkDevMgrGetGadgetLinkStatusSafe(DdkDevMgrHandleGadget handle, void *priv)
{
    if (priv == NULL || handle == NULL) {
        HDF_LOGE("%{public}s: invalid param.", __func__);
        return HDF_ERR_INVALID_OBJECT;
    }
    int32_t gadgetStatus = 0;
    if (DdkDevMgrGetGadgetStatus(&gadgetStatus) != HDF_SUCCESS) {
        HDF_LOGE("%{public}s: DdkDevMgrGetGadgetStatus failed", __func__);
        return HDF_FAILURE;
    }
    // gadget add
    if (gadgetStatus != 0) {
        // call back
        if (handle(priv) != HDF_SUCCESS) {
            HDF_LOGW("%{public}s: handle failed", __func__);
        }
    }
    return HDF_SUCCESS;
}

bool DdkDevMgrGetGadgetLinkStatus()
{
    int32_t gadgetStatus = 0;
    if (DdkDevMgrGetGadgetStatus(&gadgetStatus) != HDF_SUCCESS) {
        HDF_LOGE("%{public}s: DdkDevMgrGetGadgetStatus failed", __func__);
        return false;
    }
    // gadget add
    if (gadgetStatus != 0) {
        return gadgetStatus == USB_PNP_DRIVER_GADGET_ADD ? true : false;
    }
    return false;
}
#endif                                                                          // USB_EVENT_NOTIFY_LINUX_NATIVE_MODE