qcacmn: Add qdf_delayed_work

Add a new deferred work type, qdf_delayed_work, which executes a
callback after a delay. This type is meant to supersede
qdf_delayed_work_t, with a more consistent API and without typedefs.

Change-Id: I76bc59dcd4222643d70c6a763e5bc4ee9f0a487c
CRs-Fixed: 2419155
This commit is contained in:
Dustin Brown
2019-03-05 11:12:13 -08:00
committed by nshrivas
父節點 5e919958d2
當前提交 d48a842b4b
共有 5 個文件被更改,包括 267 次插入0 次删除

查看文件

@@ -0,0 +1,87 @@
/*
* Copyright (c) 2019 The Linux Foundation. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
* above copyright notice and this permission notice appear in all
* copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
* WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
* AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
* PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
/**
* DOC: qdf_delayed_work.h
* A simple, delayed work type for executing a callback after some delay.
*/
#ifndef __QDF_DELAYED_WORK_H
#define __QDF_DELAYED_WORK_H
#include "i_qdf_delayed_work.h"
#include "qdf_status.h"
#include "qdf_types.h"
typedef void (*qdf_delayed_work_cb)(void *context);
/**
* struct qdf_delayed_work - a defered work type which executes a callback after
* some delay
* @dwork: OS-specific delayed work
* @callback: the callback to be executed
* @context: the context to pass to the callback
*/
struct qdf_delayed_work {
struct __qdf_opaque_delayed_work dwork;
qdf_delayed_work_cb callback;
void *context;
};
/**
* qdf_delayed_work_create() - initialized a delayed work @dwork
* @dwork: the delayed work to initialize
* @callback: the callback to be executed
* @context: the context to pass to the callback
*
* Return: QDF_STATUS
*/
qdf_must_check QDF_STATUS
qdf_delayed_work_create(struct qdf_delayed_work *dwork,
qdf_delayed_work_cb callback, void *context);
/**
* qdf_delayed_work_destroy() - deinitialize a delayed work @dwork
* @dwork: the delayed work to de-initialize
*
* Return: None
*/
void qdf_delayed_work_destroy(struct qdf_delayed_work *dwork);
/**
* qdf_delayed_work_start() - schedule execution of @dwork callback
* @dwork: the delayed work to start
* @msec: the delay before execution in milliseconds
*
* Return: true if started successfully
*/
bool qdf_delayed_work_start(struct qdf_delayed_work *dwork, uint32_t msec);
/**
* qdf_delayed_work_stop_sync() - Synchronously stop execution of @dwork
* @dwork: the delayed work to stop
*
* When this returns, @dwork is guaranteed to not be queued, and its callback
* not executing.
*
* Return: true if @dwork was queued or running
*/
bool qdf_delayed_work_stop_sync(struct qdf_delayed_work *dwork);
#endif /* __QDF_DELAYED_WORK_H */