123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165 |
- /****************************************************************************
- * sched/wqueue/kwork_cancel.c
- *
- * Copyright (C) 2014, 2016 Gregory Nutt. All rights reserved.
- * Author: Gregory Nutt <gnutt@nuttx.org>
- *
- * 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 NuttX 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 OWNER 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.
- *
- ****************************************************************************/
- /****************************************************************************
- * Included Files
- ****************************************************************************/
- #include <nuttx/config.h>
- #include <queue.h>
- #include <assert.h>
- #include <errno.h>
- #include <nuttx/irq.h>
- #include <nuttx/arch.h>
- #include <nuttx/wqueue.h>
- #include "wqueue/wqueue.h"
- #ifdef CONFIG_SCHED_WORKQUEUE
- /****************************************************************************
- * Private Functions
- ****************************************************************************/
- /****************************************************************************
- * Name: work_qcancel
- *
- * Description:
- * Cancel previously queued work. This removes work from the work queue.
- * After work has been cancelled, it may be re-queue by calling work_queue()
- * again.
- *
- * Input Parameters:
- * qid - The work queue ID
- * work - The previously queue work structure to cancel
- *
- * Returned Value:
- * Zero (OK) on success, a negated errno on failure. This error may be
- * reported:
- *
- * -ENOENT - There is no such work queued.
- * -EINVAL - An invalid work queue was specified
- *
- ****************************************************************************/
- static int work_qcancel(FAR struct kwork_wqueue_s *wqueue,
- FAR struct work_s *work)
- {
- irqstate_t flags;
- int ret = -ENOENT;
- DEBUGASSERT(work != NULL);
- /* Cancelling the work is simply a matter of removing the work structure
- * from the work queue. This must be done with interrupts disabled because
- * new work is typically added to the work queue from interrupt handlers.
- */
- flags = enter_critical_section();
- if (work->worker != NULL)
- {
- /* A little test of the integrity of the work queue */
- DEBUGASSERT(work->dq.flink != NULL ||
- (FAR dq_entry_t *)work == wqueue->q.tail);
- DEBUGASSERT(work->dq.blink != NULL ||
- (FAR dq_entry_t *)work == wqueue->q.head);
- /* Remove the entry from the work queue and make sure that it is
- * marked as available (i.e., the worker field is nullified).
- */
- dq_rem((FAR dq_entry_t *)work, &wqueue->q);
- work->worker = NULL;
- ret = OK;
- }
- leave_critical_section(flags);
- return ret;
- }
- /****************************************************************************
- * Public Functions
- ****************************************************************************/
- /****************************************************************************
- * Name: work_cancel
- *
- * Description:
- * Cancel previously queued user-mode work. This removes work from the
- * user mode work queue. After work has been cancelled, it may be re-queue
- * by calling work_queue() again.
- *
- * Input Parameters:
- * qid - The work queue ID (must be HPWORK or LPWORK)
- * work - The previously queue work structure to cancel
- *
- * Returned Value:
- * Zero (OK) on success, a negated errno on failure. This error may be
- * reported:
- *
- * -ENOENT - There is no such work queued.
- * -EINVAL - An invalid work queue was specified
- *
- ****************************************************************************/
- int work_cancel(int qid, FAR struct work_s *work)
- {
- #ifdef CONFIG_SCHED_HPWORK
- if (qid == HPWORK)
- {
- /* Cancel high priority work */
- return work_qcancel((FAR struct kwork_wqueue_s *)&g_hpwork, work);
- }
- else
- #endif
- #ifdef CONFIG_SCHED_LPWORK
- if (qid == LPWORK)
- {
- /* Cancel low priority work */
- return work_qcancel((FAR struct kwork_wqueue_s *)&g_lpwork, work);
- }
- else
- #endif
- {
- return -EINVAL;
- }
- }
- #endif /* CONFIG_SCHED_WORKQUEUE */
|