led.h

Go to the documentation of this file.

/* Copyright 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 BSPACM_UTILITY_LED_H
#define BSPACM_UTILITY_LED_H

#include <bspacm/core.h>

/* The actual implementation is board/device/series/line-specific.
 * This include file should declare the type xBSPACMled, the array
 * xBSPACMleds, and the inline function vBSPACMledSet_(). */
#include <bspacm/utility/led_.h>

extern const uint8_t nBSPACMleds;

void
vBSPACMledConfigure ();

static BSPACM_CORE_INLINE_FORCED
void
vBSPACMledSet (int idx, int mode)
{
  if ((0 <= idx) && (idx < nBSPACMleds)) {
    vBSPACMledSet_(idx, mode);
  }
}

#if (BSPACM_DOXYGEN - 0)

typedef void xBSPACMled;

extern const xBSPACMled xBSPACMleds[];

static BSPACM_CORE_INLINE_FORCED
void
vBSPACMledSet_ (int idx, int mode) { }
#endif /* BSPACM_DOXYGEN */

#endif /* BSPACM_UTILITY_LED_H */