xref: /kernel/liteos_a/drivers/char/quickstart/src/quickstart.c

/*
 * Copyright (c) 2013-2019 Huawei Technologies Co., Ltd. All rights reserved.
 * Copyright (c) 2020-2021 Huawei Device Co., Ltd. All rights reserved.
 *
 * 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.
 */

#include "los_dev_quickstart.h"
#include "fcntl.h"
#include "linux/kernel.h"
#include "los_process_pri.h"
#include "fs/file.h"
#include "fs/driver.h"

EVENT_CB_S g_qsEvent;
static SysteminitHook g_systemInitFunc[QS_STAGE_CNT] = {0};
static char g_callOnce[QS_STAGE_CNT] = {0};

static int QuickstartOpen(struct file *filep)
{
    return 0;
}

static int QuickstartClose(struct file *filep)
{
    return 0;
}

static int QuickstartNotify(unsigned int events)
{
    int ret = LOS_EventWrite((PEVENT_CB_S)&g_qsEvent, events);
    if (ret != 0) {
        PRINT_ERR("%s,%d:0x%x\n", __FUNCTION__, __LINE__, ret);
        ret = -EINVAL;
    }
    return ret;
}

#define WAITLIMIT    300000 /* 5min = 5*60*1000*1tick(1ms) */

static int QuickstartListen(unsigned long arg)
{
    QuickstartListenArgs args;
    if (copy_from_user(&args, (QuickstartListenArgs __user *)arg, sizeof(QuickstartListenArgs)) != LOS_OK) {
        PRINT_ERR("%s,%d,failed!\n", __FUNCTION__, __LINE__);
        return -EINVAL;
    }
    if (args.wait > WAITLIMIT) {
        args.wait = WAITLIMIT;
        PRINT_ERR("%s wait arg is too longer, set to WAITLIMIT!\n", __FUNCTION__);
    }
    int ret = LOS_EventRead((PEVENT_CB_S)&g_qsEvent, args.events, LOS_WAITMODE_AND | LOS_WAITMODE_CLR, args.wait);
    if (ret != args.events && ret != 0) {  /* 0: nowait is normal case */
        PRINT_ERR("%s,%d:0x%x\n", __FUNCTION__, __LINE__, ret);
        ret = -EINVAL;
    }
    return ret;
}

void QuickstartHookRegister(LosSysteminitHook hooks)
{
    for (int i = 0; i < QS_STAGE_CNT; i++) {
        g_systemInitFunc[i] = hooks.func[i];
    }
}

static int QuickstartStageWorking(unsigned int level)
{
    if ((level < QS_STAGE_CNT) && (g_callOnce[level] == 0) && (g_systemInitFunc[level] != NULL)) {
        g_callOnce[level] = 1;    /* 1: Already called */
        g_systemInitFunc[level]();
    } else {
        PRINT_WARN("Trigger quickstart,but doing nothing!!\n");
    }
    return 0;
}

static int QuickstartDevUnlink(struct Vnode *node)
{
    (void)node;
    return unregister_driver(QUICKSTART_NODE);
}

static ssize_t QuickstartIoctl(struct file *filep, int cmd, unsigned long arg)
{
    ssize_t ret;
    if (cmd == QUICKSTART_NOTIFY) {
        return QuickstartNotify(arg);
    }

    if (LOS_GetCurrProcessID() != OS_USER_ROOT_PROCESS_ID) {
        PRINT_ERR("Permission denios!\n");
        return -EACCES;
    }
    switch (cmd) {
        case QUICKSTART_LISTEN:
            ret = QuickstartListen(arg);
            break;
        default:
            ret = QuickstartStageWorking(cmd - QUICKSTART_STAGE(QS_STAGE1));  /* ioctl cmd converted to stage level */
            break;
    }
    return ret;
}

static const struct file_operations_vfs g_quickstartDevOps = {
    .open = QuickstartOpen, /* open */
    .close = QuickstartClose, /* close */
    .ioctl = QuickstartIoctl, /* ioctl */
    .unlink = QuickstartDevUnlink, /* unlink */
};

int QuickstartDevRegister(void)
{
    LOS_EventInit(&g_qsEvent);
    return register_driver(QUICKSTART_NODE, &g_quickstartDevOps, 0644, 0); /* 0644: file mode */
}