Board.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2019, Texas Instruments Incorporated
 * 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 Texas Instruments Incorporated 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.
 */

/*!****************************************************************************
 *  @file       Board.h
 *  @brief      Portable board-specific symbols
 *
 *  The Board header file should be included in an application as follows:
 *  @code
 *  #include <ti/drivers/Board.h>
 *  @endcode
 *
 *  This header serves as device-independent interface for applications using
 *  peripherals connected to the device via standard digital interfaces; e.g,
 *  GPIO, SPI, I2C, UART, etc. Its purpose is to enable application code that
 *  references a peripheral to be portable to any device and board that
 *  supports the peripheral.
 *
 *  ## Usage ##
 *
 *  @anchor ti_drivers_Board_Synopsis
 *  ### Synopsis #
 *  @anchor ti_drivers_Board_Synopsis_Code
 *  @code
 *  #include <ti/drivers/Board.h>
 *
 *  void main(void)
 *  {
 *      Board_init();
 *       :
 *  }
 *  @endcode
 *
 *  ## Initializing the hardware ##
 *
 *  \p Board_init() must be called before any other driver API. This function
 *  is owned by the user (typically generated by SysConfig), and is
 *  responsible for device specific initialization; e.g., initializing clocks
 *  and power management functionality.
 ******************************************************************************
 */

#ifndef ti_drivers_Board__include
#define ti_drivers_Board__include

#ifdef __cplusplus
extern "C" {
#endif

extern void Board_init(void);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_Board_include */