resource.h

Go to the documentation of this file.

/* Copyright 2013-2014, Peter A. Bigot
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * * 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.
 *
 * * Neither the name of the software 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.
 */

#ifndef BSP430_RESOURCE_H
#define BSP430_RESOURCE_H

#include <bsp430/core.h>

/* Forward declaration */
struct sBSP430resourceWaiter;

typedef struct sBSP430resource {
  void * volatile holder;

  unsigned int volatile count;

  struct sBSP430resourceWaiter * volatile waiter;
} sBSP430resource;

typedef struct sBSP430resource * hBSP430resource;

typedef int (* iBSP430resourceWaitCallback_ni) (hBSP430resource resource,
                                                struct sBSP430resourceWaiter * waiter);

typedef struct sBSP430resourceWaiter {
  iBSP430resourceWaitCallback_ni callback_ni;

  const void * context;

  struct sBSP430resourceWaiter * volatile next;
} sBSP430resourceWaiter;

typedef enum eBSP430resourceWait {
  eBSP430resourceWait_NONE,

  eBSP430resourceWait_FIFO,

  eBSP430resourceWait_LIFO,
} eBSP430resourceWait;

typedef struct sBSP430resourceWaiter * hBSP430resourceWaiter;

int iBSP430resourceClaim_ni (hBSP430resource resource,
                             void * self,
                             eBSP430resourceWait wait_type,
                             hBSP430resourceWaiter waiter);

int iBSP430resourceRelease_ni (hBSP430resource resource,
                               void * self);

int iBSP430resourceCancelWait_ni (hBSP430resource resource,
                                  hBSP430resourceWaiter waiter);

typedef struct sBSP430resourceReleaseFlag {
  volatile unsigned int * flagp;

  unsigned int flagv;
} sBSP430resourceReleaseFlag;

int iBSP430resourceSetFlagOnRelease (hBSP430resource resource,
                                     hBSP430resourceWaiter waiter);

#endif /* BSP430_RESOURCE_H */