appcfg.h File Reference

---

Detailed Description

Application Configuration functions.

Author:

Modtronix Engineering

Dependencies:

none

Compiler:

MPLAB C18 v2.10 or higher
HITECH PICC-18 V8.35PL3 or higher

Description

For details on application configuration data, see Application Configuration module!

Configuration

The following defines are used to configure this module, and should be placed in the projdefs.h (or similar) file. For details, see Project Configuration. To configure the module, the required defines should be uncommended, and the rest commented out.

 //*******************************************************
 //----------------- Appcfg Configuration -----------------
 //********************************************************
 //Define if this application has an 8 bit ADC converter, 10 bit ADC converter or none at all.
 //#define APP_USE_ADC8
 //#define APP_USE_ADC10

 //Define buffer space that is reserved for ADC conversion values. For a 8 bit ADC converted, 1 byte
 //is reserved per channel. For an 10 bit ADC, 2 bytes are reserved per channel.
 //#define ADC_CHANNELS 12

#include "net\ip.h"

Data Structures
struct	_ADC_CFG
struct	_APP_CONFIG
struct	_PORT_CFG
struct	_PORT_VALUES
struct	_USART_CFG
Defines
#define	APPCFG_NETFLAGS_DHCP   0x01
#define	APPCFG_SMALLER_256
#define	APPCFG_SYSFLAGS_BLINKB6   0x02
#define	APPCFG_SYSFLAGS_PLLON   0x01
#define	APPCFG_USERNAME_LEN   9
#define	appcfgGetcAtField(field)   appcfgGetc(offsetof(APP_CONFIG, field))
#define	appcfgPutc(offset, value)   EEDATA = (value); _appcfgPutc(offset)
#define	appcfgPutcAtField(field, value)   EEDATA = (value); _appcfgPutc(offsetof(APP_CONFIG, field))
#define	BAUD_115200   8
#define	BAUD_1200   1
#define	BAUD_19200   5
#define	BAUD_230400   9
#define	BAUD_2400   2
#define	BAUD_300   0
#define	BAUD_38400   6
#define	BAUD_460800   10
#define	BAUD_4800   3
#define	BAUD_57600   7
#define	BAUD_921600   11
#define	BAUD_9600   4
Typedefs
typedef _ADC_CFG	ADC_CFG
typedef _APP_CONFIG	APP_CONFIG
typedef _PORT_CFG	PORT_CFG
typedef _PORT_VALUES	PORT_VALUE
typedef _USART_CFG	USART_CFG
Enumerations
enum	APP_CONFIG_ENUM {   APPCFG_IP0 = 0, APPCFG_IP1, APPCFG_IP2, APPCFG_IP3,   APPCFG_MAC0, APPCFG_MAC1, APPCFG_MAC2, APPCFG_MAC3,   APPCFG_MAC4, APPCFG_MAC5, APPCFG_MASK0, APPCFG_MASK1,   APPCFG_MASK2, APPCFG_MASK3, APPCFG_GATEWAY0, APPCFG_GATEWAY1,   APPCFG_GATEWAY2, APPCFG_GATEWAY3, APPCFG_WAIT4BL, APPCFG_FLASH_HAS_PROGRAM,   APPCFG_STARTUP_SER_DLY, APPCFG_SYSFLAGS, APPCFG_NETFLAGS, APPCFG_SMTP_SRVR_ADR0,   APPCFG_SMTP_SRVR_ADR1, APPCFG_SMTP_SRVR_ADR2, APPCFG_SMTP_SRVR_ADR3, APPCFG_TFTP_SRVR_ADR0,   APPCFG_TFTP_SRVR_ADR1, APPCFG_TFTP_SRVR_ADR2, APPCFG_TFTP_SRVR_ADR3, APPCFG_USART1_BAUD,   APPCFG_USART1_CFG, APPCFG_USART2_BAUD, APPCFG_USART2_CFG, APPCFG_TRISA,   APPCFG_TRISB, APPCFG_TRISC, APPCFG_TRISD, APPCFG_TRISE,   APPCFG_TRISF, APPCFG_TRISG, APPCFG_PORTA, APPCFG_PORTB,   APPCFG_PORTC, APPCFG_PORTD, APPCFG_PORTE, APPCFG_PORTF,   APPCFG_PORTG, APPCFG_ADCON1, APPCFG_ADCON0_2, APPCFG_SERIAL_NUMBER0,   APPCFG_SERIAL_NUMBER1, APPCFG_USERNAME0, APPCFG_USERNAME1, APPCFG_USERNAME2,   APPCFG_USERNAME3, APPCFG_USERNAME4, APPCFG_USERNAME5, APPCFG_USERNAME6,   APPCFG_USERNAME7, APPCFG_USERNAME8, APPCFG_PASSWORD0, APPCFG_PASSWORD1,   APPCFG_PASSWORD2, APPCFG_PASSWORD3, APPCFG_PASSWORD4, APPCFG_PASSWORD5,   APPCFG_PASSWORD6, APPCFG_PASSWORD7, APPCFG_PASSWORD8 }
Functions
void	_appcfgPutc (BYTE offset)
void	appcfgADC (void)
void	appcfgCpuIO (void)
void	appcfgCpuIOValues (void)
BYTE	appcfgGetc (BYTE offset)
void	appcfgInit (void)
void	appcfgSave (void)
void	appcfgUSART (void)
Variables
APP_CONFIG	AppConfig

---

Define Documentation

#define APPCFG_NETFLAGS_DHCP   0x01

Mask for bits in APPCFG_NETFLAGS config byte.

#define APPCFG_SMALLER_256

Define this if APP_CONFIG is smaller then 256 bytes. When this is defined the code knows that it only need 1 byte to address all configuration bytes. This produces smaller and faster code.

#define APPCFG_USERNAME_LEN   9

#define appcfgGetcAtField

(

field

)

appcfgGetc(offsetof(APP_CONFIG, field))

Gets a specified byte from the APP_CONFIG configuration structure

Parameters:

field

The byte to get from the APP_CONFIG structure. For example "MyMask.v[0]"

Returns:

Returns the requested byte

#define appcfgPutc	(	offset,
		value		)	EEDATA = (value); _appcfgPutc(offset)

Set a specified byte in the APP_CONFIG configuration structure to a given value. This function will only update the EEPROM if the given new value is different from the current old value. This saves the EEPROM, and increases it's live!

Parameters:

	offset	The byte to set in the APP_CONFIG structure. Use the APPCFG_X defines
	value	Contains the value to set the given byte to

Returns:

Returns the requested byte

#define appcfgPutcAtField	(	field,
		value		)	EEDATA = (value); _appcfgPutc(offsetof(APP_CONFIG, field))

Set a specified byte from the APP_CONFIG configuration structure to a given value.

Parameters:

	field	The byte to set in the APP_CONFIG structure. For example "MyMask.v[0]"
	value	Contains the value to set the given byte to

Returns:

Returns the requested byte

#define BAUD_115200   8

#define BAUD_1200   1

#define BAUD_19200   5

#define BAUD_230400   9

#define BAUD_2400   2

#define BAUD_300   0

#define BAUD_38400   6

#define BAUD_460800   10

#define BAUD_4800   3

#define BAUD_57600   7

#define BAUD_921600   11

#define BAUD_9600   4

---

Typedef Documentation

typedef struct _ADC_CFG ADC_CFG

Structure for storing ADC configuration data. Data is stored in internal EEPROM

typedef struct _APP_CONFIG APP_CONFIG

Structure for storing application configuration data that needs fast access. This structure is created in the processors internal RAM, and is initialized with the contents of the corresponding bytes in EEPROM at startup. Whenever the application needs to access any of these variables, it will read them straight from this RAM structure in stead of reading them from the EEPROM.

typedef struct _PORT_CFG PORT_CFG

Structure for storing port configuration data. Data is stored in internal EEPROM

typedef struct _PORT_VALUES PORT_VALUE

Structure for storing default port value. Data is stored in internal EEPROM

typedef struct _USART_CFG USART_CFG

Structure for storing USART configuration data. Data is stored in internal EEPROM

---

Enumeration Type Documentation

enum APP_CONFIG_ENUM

Main application config structure. This structure lives in the internal EEPROM, starting at address 0.
!!! IMPORTANT - Only add to end the of this structure!!!
This structure can NOT get larger then 256 bytes. If it does, some code will have to be changed!

Enumerator:

APPCFG_IP0	Offset = 0 = 0x00. Our IP address. First entry is MSB byte of IP address, for example in "192.168.1.0" it will be 192.
APPCFG_IP1	Offset = 1 = 0x01.
APPCFG_IP2	Offset = 2 = 0x02.
APPCFG_IP3	Offset = 3 = 0x03. Our MAC address. First entry is MSB byte of MAC address
APPCFG_MAC0	Offset = 4 = 0x04.
APPCFG_MAC1	Offset = 5 = 0x05.
APPCFG_MAC2	Offset = 6 = 0x06.
APPCFG_MAC3	Offset = 7 = 0x07.
APPCFG_MAC4	Offset = 8 = 0x08.
APPCFG_MAC5	Offset = 9 = 0x09. Our Mask. First entry is MSB of MASK address, for example if mask is 255.0.0.0 it will be 255
APPCFG_MASK0	Offset = 10 = 0x0A.
APPCFG_MASK1	Offset = 11 = 0x0B.
APPCFG_MASK2	Offset = 12 = 0x0C.
APPCFG_MASK3	Offset = 13 = 0x0D. Our Gateway address. First entry is MSB byte of IP address, for example in "192.168.1.254" it will be 192
APPCFG_GATEWAY0	Offset = 14 = 0x0E.
APPCFG_GATEWAY1	Offset = 15 = 0x0F.
APPCFG_GATEWAY2	Offset = 16 = 0x10.
APPCFG_GATEWAY3	Offset = 17 = 0x11. Delay how long we wait for the bootloader, value from 0-n. Time = 0.8sec x n
APPCFG_WAIT4BL	Offset = 18 = 0x12. If 0, the FLASH has not been programmed yet, or does NOT contain a valid program. In this case we can not exit bootloader mode!
APPCFG_FLASH_HAS_PROGRAM	Offset = 19 = 0x13. Time to delay (n x 50ms) on startup and give chance to press key and enter serial config. If 0, skip
APPCFG_STARTUP_SER_DLY	Offset = 20 = 0x14. System flags Bit 0: 4 x PLL enable flag Bit 1: Blink led on B6
APPCFG_SYSFLAGS	Offset = 21 = 0x15. Network flags. Bit 0: DHCP enable flag
APPCFG_NETFLAGS	Offset = 22 = 0x16. SMTP Server address
APPCFG_SMTP_SRVR_ADR0	Offset = 23 = 0x17.
APPCFG_SMTP_SRVR_ADR1	Offset = 24 = 0x18.
APPCFG_SMTP_SRVR_ADR2	Offset = 25 = 0x19.
APPCFG_SMTP_SRVR_ADR3	Offset = 26 = 0x1A. TFTP Server address
APPCFG_TFTP_SRVR_ADR0	Offset = 27 = 0x1B.
APPCFG_TFTP_SRVR_ADR1	Offset = 28 = 0x1C.
APPCFG_TFTP_SRVR_ADR2	Offset = 29 = 0x1D.
APPCFG_TFTP_SRVR_ADR3	Offset = 30 = 0x1E. USART1 Configuration. Baud rate will be a BAUD_XXX define
APPCFG_USART1_BAUD	Offset = 31 = 0x1F.
APPCFG_USART1_CFG	Offset = 32 = 0x20. USART2 Configuration. Baud rate will be a BAUD_XXX define
APPCFG_USART2_BAUD	Offset = 33 = 0x21.
APPCFG_USART2_CFG	Offset = 34 = 0x22. Port direction configuration
APPCFG_TRISA	Offset = 35 = 0x23.
APPCFG_TRISB	Offset = 36 = 0x24.
APPCFG_TRISC	Offset = 37 = 0x25.
APPCFG_TRISD	Offset = 38 = 0x26.
APPCFG_TRISE	Offset = 39 = 0x27.
APPCFG_TRISF	Offset = 40 = 0x28.
APPCFG_TRISG	Offset = 41 = 0x29. Port default values
APPCFG_PORTA	Offset = 42 = 0x2A.
APPCFG_PORTB	Offset = 43 = 0x2B.
APPCFG_PORTC	Offset = 44 = 0x2C.
APPCFG_PORTD	Offset = 45 = 0x2D.
APPCFG_PORTE	Offset = 46 = 0x2E.
APPCFG_PORTF	Offset = 47 = 0x2F.
APPCFG_PORTG	Offset = 48 = 0x30. ADC configuration
APPCFG_ADCON1	Offset = 49 = 0x31.
APPCFG_ADCON0_2	Offset = 50 = 0x32. Serial number
APPCFG_SERIAL_NUMBER0	Offset = 51 = 0x33.
APPCFG_SERIAL_NUMBER1	Offset = 52 = 0x34. Username - Is a null terminated string. Max 8 char + null termination char
APPCFG_USERNAME0	Offset = 53 = 0x35.
APPCFG_USERNAME1	Offset = 54 = 0x36.
APPCFG_USERNAME2	Offset = 55 = 0x37.
APPCFG_USERNAME3	Offset = 56 = 0x38.
APPCFG_USERNAME4	Offset = 57 = 0x39.
APPCFG_USERNAME5	Offset = 58 = 0x3A.
APPCFG_USERNAME6	Offset = 59 = 0x3B.
APPCFG_USERNAME7	Offset = 60 = 0x3C.
APPCFG_USERNAME8	Offset = 61 = 0x3D. Password - Is a null terminated string. Max 8 char + null termination char
APPCFG_PASSWORD0	Offset = 62 = 0x3E.
APPCFG_PASSWORD1	Offset = 63 = 0x3F.
APPCFG_PASSWORD2	Offset = 64 = 0x40.
APPCFG_PASSWORD3	Offset = 65 = 0x41.
APPCFG_PASSWORD4	Offset = 66 = 0x42.
APPCFG_PASSWORD5	Offset = 67 = 0x43.
APPCFG_PASSWORD6	Offset = 68 = 0x44.
APPCFG_PASSWORD7	Offset = 69 = 0x45.
APPCFG_PASSWORD8	Offset = 70 = 0x46.

---

Function Documentation

void _appcfgPutc

(

BYTE

offset

)

Set a specified byte from the APP_CONFIG configuration structure with the data contained in the EEDATA byte.

Parameters:

offset

Contains the offset in the APP_CONFIG structure of the byte to get

Returns:

Returns the requested byte

void appcfgADC

(

void

)

Configure the ADC unit

void appcfgCpuIO

(

void

)

Configure the CPU I/O ports

void appcfgCpuIOValues

(

void

)

Configure the CPU I/O ports to have the configured default values

BYTE appcfgGetc

(

BYTE

offset

)

Get a specified byte from the APP_CONFIG configuration structure

Parameters:

offset

Contains the offset in the APP_CONFIG structure of the byte to get. Use the APPCFG_X defines

Returns:

Returns the requested byte

void appcfgInit

(

void

)

Pre-Condition:

fsysInit() is already called.

void appcfgSave

(

void

)

Save Application Configuartion data to EEPROM

void appcfgUSART

(

void

)

Configure USART with AppConfig data

---

Variable Documentation

APP_CONFIG AppConfig

---