types.h

Go to the documentation of this file.

#ifndef EVE_TOC_TYPES_H_INCLUDED
#define EVE_TOC_TYPES_H_INCLUDED
/**********************************************************************/
/*
 * Copyright (c) 2013-2015, Jetro AS
 * All rights reserved.
 *
 * 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. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONRIBUTORS ``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 AUTHOR 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.
 *
 * This file is part of the EVE platform.
 */

/**
 * \file
 * @brief TOC module basic types
 *
 * @author DT, Jetro AS
 */ /******************************************************************/

#include <ble_types.h>

/**
 * @addtogroup toc
 * @{
 */

/**
 * System part of segment types
 *
 * User code may extend the segments with own ones.
 */
enum toc_segment_type_t
{
  SEGMENT_NONE,
  SEGMENT_RAM,
  SEGMENT_COMMAND,
  SEGMENT_SERVICES,
  SEGMENT__SYSTEM_END = SEGMENT_SERVICES,
};

/**
 * TOC table with all the stuff
 */
struct toc_blob_t
{
  const struct toc_t *Toc;                /**< Pointer to the toc table */
  const char *StringPool;                 /**< Pointer to the string pool */
  uint8_t Count;                          /**< Number of elements in the tables */
};

/**
 * User-defined context of file operations
 */
struct app_file_context_t;

/**
 * System context of file operations
 */
struct toc_file_context_t
{
  struct app_file_context_t *User;        /**< User data */
};

/**
 * User-defined RAM segment, forward declaration of the structure
 */
struct toc_data_t;

/**
 * user-defined RAM segment
 */
extern struct toc_data_t TocData;

/**
 * User-defined command segment, forward declaration of the structure
 */
union toc_command_t;

/**
 * user-defined command segment
 */
extern union toc_command_t TocCommand;

/**
 * Service descriptor
 */
struct toc_service_t
{
  ble_uuid128_t uuid128;
};

/**
 * User-defined services description table
 */
struct toc_services_t;

/**
 * user-defined services segment
 */
extern const struct toc_services_t TocServices;

/** @} */ /* toc */

#endif /* EVE_TOC_TYPES_H_INCLUDED */