123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149 |
- /****************************************************************************
- * mm/iob/iob_notifier.c
- *
- * Copyright (C) 2018 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 <sys/types.h>
- #include <assert.h>
- #include <nuttx/wqueue.h>
- #include <nuttx/mm/iob.h>
- #include "iob.h"
- #ifdef CONFIG_IOB_NOTIFIER
- /****************************************************************************
- * Public Functions
- ****************************************************************************/
- /****************************************************************************
- * Name: iob_notifier_setup
- *
- * Description:
- * Set up to perform a callback to the worker function when an IOB is
- * available. The worker function will execute on the selected priority
- * worker thread.
- *
- * Input Parameters:
- * qid - Selects work queue. Must be HPWORK or LPWORK.
- * worker - The worker function to execute on the high priority work queue
- * when the event occurs.
- * arg - A user-defined argument that will be available to the worker
- * function when it runs.
- *
- * Returned Value:
- * > 0 - The notification is in place. The returned value is a key that
- * may be used later in a call to iob_notifier_teardown().
- * == 0 - There are already free IOBs. No notification will be provided.
- * < 0 - An unexpected error occurred and notification will occur. The
- * returned value is a negated errno value that indicates the
- * nature of the failure.
- *
- ****************************************************************************/
- int iob_notifier_setup(int qid, worker_t worker, FAR void *arg)
- {
- struct work_notifier_s info;
- DEBUGASSERT(worker != NULL);
- info.evtype = WORK_IOB_AVAIL;
- info.qid = qid;
- info.qualifier = NULL;
- info.arg = arg;
- info.worker = worker;
- return work_notifier_setup(&info);
- }
- /****************************************************************************
- * Name: iob_notifier_teardown
- *
- * Description:
- * Eliminate an IOB notification previously setup by iob_notifier_setup().
- * This function should only be called if the notification should be
- * aborted prior to the notification. The notification will automatically
- * be torn down after the notification.
- *
- * Input Parameters:
- * key - The key value returned from a previous call to
- * iob_notifier_setup().
- *
- * Returned Value:
- * Zero (OK) is returned on success; a negated errno value is returned on
- * any failure.
- *
- ****************************************************************************/
- int iob_notifier_teardown(int key)
- {
- /* This is just a simple wrapper around work_notifier_teardown(). */
- return work_notifier_teardown(key);
- }
- /****************************************************************************
- * Name: iob_notifier_signal
- *
- * Description:
- * An IOB has become available. Signal all threads waiting for an IOB
- * that an IOB is available.
- *
- * When an IOB becomes available, *all* of the workers waiting for an
- * IOB will be executed. If there are multiple workers waiting for an IOB
- * then only the first to execute will get the IOB. Others will
- * need to call iob_notify_setup() once again.
- *
- * Input Parameters:
- * None.
- *
- * Returned Value:
- * None.
- *
- ****************************************************************************/
- void iob_notifier_signal(void)
- {
- /* This is just a simple wrapper around work_notifier_signal(). */
- return work_notifier_signal(WORK_IOB_AVAIL, NULL);
- }
- #endif /* CONFIG_IOB_NOTIFIER */
|