module.h

/*
 Routines for CBUS FLiM operations - part of CBUS libraries for PIC 18F
  This work is licensed under the:
      Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
   To view a copy of this license, visit:
      http://creativecommons.org/licenses/by-nc-sa/4.0/
   or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
   License summary:
    You are free to:
      Share, copy and redistribute the material in any medium or format
      Adapt, remix, transform, and build upon the material
    The licensor cannot revoke these freedoms as long as you follow the license terms.
    Attribution : You must give appropriate credit, provide a link to the license,
                   and indicate if changes were made. You may do so in any reasonable manner,
                   but not in any way that suggests the licensor endorses you or your use.
    NonCommercial : You may not use the material for commercial purposes. **(see note below)
    ShareAlike : If you remix, transform, or build upon the material, you must distribute
                  your contributions under the same license as the original.
    No additional restrictions : You may not apply legal terms or technological measures that
                                  legally restrict others from doing anything the license permits.
   ** For commercial use, please contact the original copyright holder(s) to agree licensing terms
**************************************************************************************************************
	The FLiM routines have no code or definitions that are specific to any
	module, so they can be used to provide FLiM facilities for any module 
	using these libraries.
	
*/ 
/* 
 * File:   module.h
 * Author: Ian
 *
 * The CBUS library files include this module specific header. 
 * This is the means to isolate dependencies between the library and the module
 * specific code. All the dependencies of the library on the module specific code
 * should be defined in this file.
 * 
 * In particular EEPROM, NV and Event definitions should be here or included from here.
 *  
 * Created on 15 April 2017, 21:33
 */

#ifndef MODULE_H
#define	MODULE_H

#ifdef	__cplusplus
extern "C" {
#endif
    
/*********************** MODULE OPTIONS **************************/
// BOOTLOADER
#define BOOTLOADER_PRESENT

// We'll be using event hash tables for fast access - at the expense of some RAM
//#define HASH_TABLE


// enable this for additional validation checks
//#define SAFETY

// Whether NVs are cached in RAM
//#define NV_CACHE
    
    
/************************* END OF OPTIONS ************************/

    // Whether the module uses high or low priority for CAN interrupts
    // set to 0 for LP. Set to 0xFF for HP
#define CAN_INTERRUPT_PRIORITY 0    // all low priority
     
#define ACTION_T   unsigned char
#define HAPPENING_T	unsigned char
    
#include "computeNv.h"
#include "computeEEPROM.h"
#include "rules.h"

/* callback definitions from CBUSlib back into the application */
#define APP_addEvent addEvent   // No need for adding EV callback
    
/*
 * EVENTS
 */
typedef struct {
    BYTE dataIndex;
} COMPUTE_ACTION_T;


#include "computeEvents.h"

/*
 * FLASH bounds
 */
#define MIN_WRITEABLE_FLASH     ((int)(AT_NVPTR)&0xFFC0)
#ifdef __18F25K80
#define MAX_WRITEABLE_FLASH     0x7FFF
#endif
 #ifdef __18F26K80
#define MAX_WRITEABLE_FLASH     0xFFFF
#endif 
    
#include "cancompute.h"
    
/*
 * Actions
 */
#define ACTION_QUEUE_SIZE 	16	// The size needs to be big enough to store all the pending actions 
                                // Need to allow +1 to separate the ends of the cyclic buffer so need to 
                                // move the next power of two since cyclic wrapping is done with a bitmask.
                                // 16 is safer as we have wait actions
#define NUM_ACTION_QUEUES   6
#define TIMED_RESPONSE

extern WORD globalTimeStamp;
    
#ifdef	__cplusplus
}
#endif

#endif	/* MODULE_H */