Board Specific Support Functions: Definitions and Prototypes More...

#include <c6x.h>
#include <BoardSupport/inc/dm2dm642.h>
#include <csl.h>
#include <csl_cache.h>

Macros
#define	COMMON_CODE_SECTION ".commontext"

#define	CHIP_DM642

#define	INC_CPRINTF

#define	INC_COMMON

#define	INC_UART

#define	INC_TIMER

#define	CPRINTF_CCS_AVAILABLE 1

#define	CPRINTF_UART_AVAILABLE 1

#define	USE_UART_CONTROL 1

#define	CPRINTF_DEFAULT_OUTPUT CPRINTF_UART_OUTPUT /* UART outputs */

#define	TIMER_HANDLER_FUNCTION eventTimerHandler

#define	SYSTEM_TIMER TIMER_DEVANY

#define	AckTimerInterrupt()

#define	SYSTEM_TIMER_INT 10

#define	TIMER_HANDLER_INTERRUPT interrupt void TIMER_HANDLER_FUNCTION(void)

#define	BLANK_REV CPuts(" \| \|\r\n");

#define	START_UP_MESSAGE(rev)

#define	tpOutputFunc tpOutputFunc

#define	FTP_BUFFER_SIZE 0x20000 /* used in FTP client and server */

#define	TCP_TX_PACKETS 64

#define	TCP_SEND_BUFFER_SIZE (TCP_MAX_PACKET_SIZE * TCP_TX_PACKETS)

#define	KA_TIMEOUT(x) ((x)*UINT32_C(120000))

#define	FTP_SERVER_TIMEOUT UINT32_C(50000000) /* used in FTP server */

#define	CONNECT_TIMEOUT UINT32_C(1000000) /* used in FTP client */

#define	SMTP_CONNECT_TIMEOUT UINT32_C(50000) /* used in SMTP */

#define	SHUTDOWN_TIMEOUT UINT32_C(10000) /* used in SMTP */

#define	GET_CLOCK DM2_dspGetClock()

#define	ANIMATE_SYMBOLS_COUNT 4

#define	ASSERT_UART() if (h_Uart == NULL) prg_exit ("No UART handle error")

Typedefs
typedef int(*	tpOutputFunc) (const char *format,...)

Functions
void	BoardAppInit (uint32_t dsp_clock)
	board specific initialization More...

void	BoardPeripheralInit (void)
	board specific peripheral initialization More...

void	BoardPeripheralClose (void)
	close board specific peripherals More...

void	BoardInitializeInterrupts (void)
	initialize interrupts More...

void	BoardEnableInterrupts (void)
	global enable interrupts More...

void	BoardDisableInterrupts (void)

void	BoardDisableEDMA (void)

void	link_status (uint8_t mode)
	link status change callback function More...

uint16_t	monitor_link_status (tpOutputFunc pLog)
	monitor link status change More...

uint16_t	monitor_ip_address (tpOutputFunc pLog)
	monitor IP assignment More...

int	InitializeNetwork (uint16_t icmp_size)
	Initialize MAC, sockets and protocols. More...

int	BoardUartInit (void)
	Initialize UART. More...

void	BoardUartWriteString (const char *str)
	write string over UART More...

int	BoardUartWriteFormattedString (const char *format,...)
	write formatted string over UART More...

int32_t	BoardUartWriteChar (char c)
	write one character via the UART More...

int32_t	BoardUartReadChar (char *c)
	read one character from the UART More...

char *	BoardUartReadString (char *dst, size_t maxlen, uint32_t timeout, int32_t echo)
	read String from UART More...

int	BoardInitializeTimer (uint32_t timer_clock, int port, uint32_t utime)
	Initialize timer. More...

void	BoardPlugTimerHandler (int32_t cpuint, int port, void(*eventTimerHandler)(void))
	install timer interrupt handler More...

void	BoardStartTimer (int port)
	start timer More...

void	BoardStopTimer (int port)
	stop timer More...

void	LED_init ()

void	LED_off (unsigned int ledNum)

void	LED_on (unsigned int ledNum)

void	LED_toggle (unsigned int ledNum)

uint16_t	LED_state (void)

void	KEY_init (void)

int	KEY_pressed (unsigned int keyNum)

Variables
Uint16	SystemTimerDev

uint32_t	DspClock

uint32_t	TimerClock

char	module_str []

char	sym_animate []

T_Handle	h_Uart

char *	printf_uart_str

Detailed Description

                          _         _             _
                       __| |    ___(_) ____ _ __ | |_
                      / _` |   / __| |/ _` | '_ \| __|
                     | (_| | _ \__ \ | (_| | | | | |_
                      \__,_|(_) ___/_|\__, |_| |_|\__|
                     Signalprocessing |___/ Technology

Author: D.SignT GmbH & Co. KG, Claus Hermbusche

Date: 2019-06-04

Macro Definition Documentation

#define COMMON_CODE_SECTION ".commontext"

#define CHIP_DM642

#define INC_CPRINTF

define available peripheralsinclude CPrintf defines: cprintf.h

#define INC_COMMON

include Common functions: Common.h

#define INC_UART

include UART IO support: uartio.h

#define INC_TIMER

include timer module: timer.h

#define CPRINTF_CCS_AVAILABLE 1

enable available CPrintf Outputs

#define CPRINTF_UART_AVAILABLE 1

#define USE_UART_CONTROL 1

#define CPRINTF_DEFAULT_OUTPUT CPRINTF_UART_OUTPUT /* UART outputs */

Examples:: Blocksend.c, Chat.c, DHCPTest.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPdynamic.c, HTTPjava.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SMTP.c, SNTPTest.c, and Telnet.c.

#define TIMER_HANDLER_FUNCTION eventTimerHandler

Timer handler function prototype for timer.c

#define SYSTEM_TIMER TIMER_DEVANY

Timer port assignment available ports: 0 and 1 -1: let the CSL select the next free timer define TIMER_DEVANY (-1) define TIMER_DEV0 (0) define TIMER_DEV1 (1)

Examples:: Blocksend.c, Chat.c, DHCPTest.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPdynamic.c, HTTPjava.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SMTP.c, SNTPTest.c, and Telnet.c.

#define AckTimerInterrupt ( )

#define SYSTEM_TIMER_INT 10

Timer CPU interrupt

Examples:: Blocksend.c, BoardSpecific.c, Chat.c, DHCPTest.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPdynamic.c, HTTPjava.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SMTP.c, SNTPTest.c, and Telnet.c.

#define TIMER_HANDLER_INTERRUPT interrupt void TIMER_HANDLER_FUNCTION(void)

#define BLANK_REV CPuts(" | |\r\n");

start-up message

Examples:: Blocksend.c, Chat.c, DHCPTest.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPdynamic.c, HTTPjava.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SMTP.c, SNTPTest.c, and Telnet.c.

#define START_UP_MESSAGE ( rev )

Value:

CPuts (CLRSCR""VT100_BLUE); \
    CPuts ("  ---------------------------------------------------------\r\n"); \
    CPrintf (" | D.SignT GmbH & Co. KG         %25s |\r\n", program_name); \
    CPuts (" |                                                         |\r\n"); \
    CPrintf (" | (c) %d D.SignT                          www.dsignt.de |\r\n",BUILD_YEAR); \
    rev \
    CPuts ("  ---------------------------------------------------------\r\n"VT100_DEFAULT);

Examples:: Blocksend.c, Chat.c, DHCPTest.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPdynamic.c, HTTPjava.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SMTP.c, SNTPTest.c, and Telnet.c.

#define tpOutputFunc tpOutputFunc

#define FTP_BUFFER_SIZE 0x20000 /* used in FTP client and server */

Examples:: FTPClient.c.

#define TCP_TX_PACKETS 64

#define TCP_SEND_BUFFER_SIZE (TCP_MAX_PACKET_SIZE * TCP_TX_PACKETS)

Examples:: Blocksend.c.

#define KA_TIMEOUT ( x ) ((x)*UINT32_C(120000))

Examples:: Blocksend.c, and Echo.c.

#define FTP_SERVER_TIMEOUT UINT32_C(50000000) /* used in FTP server */

Examples:: FTPServer.c.

#define CONNECT_TIMEOUT UINT32_C(1000000) /* used in FTP client */

Examples:: FTPClient.c.

#define SMTP_CONNECT_TIMEOUT UINT32_C(50000) /* used in SMTP */

Examples:: SMTP.c.

#define SHUTDOWN_TIMEOUT UINT32_C(10000) /* used in SMTP */

Examples:: SMTP.c.

#define GET_CLOCK DM2_dspGetClock()

Examples:: Blocksend.c, Chat.c, DHCPTest.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPdynamic.c, HTTPjava.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SMTP.c, SNTPTest.c, and Telnet.c.

#define ANIMATE_SYMBOLS_COUNT 4

Examples:: Chat.c, DHCPTest.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPdynamic.c, HTTPjava.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, PServer.c, Receive.c, Send.c, SMTP.c, and Telnet.c.

#define ASSERT_UART ( ) if (h_Uart == NULL) prg_exit ("No UART handle error")

UART check

Examples:: BoardSpecific.c.

Typedef Documentation

typedef int(* tpOutputFunc) (const char *format,...)

Message log function. E.g. printf() or CPrintf() Use with net_print_stat()

Function Documentation

void BoardAppInit ( uint32_t dsp_clock )

Parameters

dsp_clock [Hz]

Returns: nothing

Make board specific settings. Store or determine configured clocks. Call further board specific initialization functions for e.g PLL, EMIF, XINTF and prepare interrupts.

 {
     /***************************************************************************
      locals
     ***************************************************************************/
 
     BoardDisableInterrupts();
 //    BoardDisableEDMA();
 
     /***************************************************************************
       store DSP clock
     ***************************************************************************/
     DspClock = dsp_clock;
     TimerClock = dsp_clock>>3;
 
     /***************************************************************************
      basic initialisation, call bios function init_module()
     ***************************************************************************/
     DM2_init();
 
     /***************************************************************************
       initialize interrupt system
     ***************************************************************************/
 #if (!(defined(USE_DSPBIOS) || defined(USE_SYSBIOS)))
 //    DM2_intInit (&DM2_intServiceTable);
 #endif
 }

void BoardPeripheralInit ( void )

Parameters

-

Returns: nothing

 {
     /***************************************************************************
       initialize Chip Support Library
     ***************************************************************************/
     CSL_init();
 
     /***************************************************************************
       make SDRAM cacheable
     ***************************************************************************/
     CACHE_enableCaching(CACHE_EMIFA_CE00);
     CACHE_enableCaching(CACHE_EMIFA_CE01);
     CACHE_enableCaching(CACHE_EMIFA_CE02);
     CACHE_enableCaching(CACHE_EMIFA_CE03);
 
     /***************************************************************************
       initialize FLASH
     ***************************************************************************/
     DM2_flashOpen();
 #ifdef USE_SPIDRIVE
 
 
     /***************************************************************************
       configure GPIO2 (PRGIO[6]) as input for card detect signal
     ***************************************************************************/
     // ConfigureCardDetect (6);
     ConfigureCardDetect (15);
 #endif
 
 }

void BoardPeripheralClose ( void )

Parameters

-

Returns: nothing

 {
     /***************************************************************************
       stop timer
     ***************************************************************************/
 #ifdef INC_TIMER
     StopSystemTimer ();
 #endif
     //~ TIMER(0)->ctl = 0x301;
     //~ TIMER_close (h_timer[0]);
     //~ TIMER_close (h_timer[1]);
     //~ TIMER_close (h_timer[2]);
     //~ TIMER_resetAll();
 
     /***************************************************************************
       disable interrupt
     ***************************************************************************/
     _disable_interrupts();
 
     /***************************************************************************
       disable DMA
     ***************************************************************************/
     //...
 
     /***************************************************************************
       close peripherals
     ***************************************************************************/
 #ifdef _UARTIO_H_
     if (h_Uart) DM2_uartClose (h_Uart);
 #endif
 
 #ifdef _USBIO_H_
     DM2_usbClose();
 #endif
 
 }

void BoardInitializeInterrupts ( void )

Parameters

-

Returns: nothing

 {
 #if (!(defined(USE_DSPBIOS) || defined(USE_SYSBIOS)))
 //    if (intcInit() != intcInit_OK) // required only once
 //    {
 //        prg_exit ("error");
 //    }
 #endif
 }

void BoardEnableInterrupts ( void )

Parameters

-

Returns: nothing

Examples:: Blocksend.c, Chat.c, DHCPTest.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPdynamic.c, HTTPjava.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SMTP.c, SNTPTest.c, and Telnet.c.

 {
     // DM2_intStart();
     _enable_interrupts();
 
     /**************************************************************************
       enable the bits for non maskable interrupt (0x02)
     **************************************************************************/
     IER |= 0x2;
 }

void BoardDisableInterrupts ( void )

 {
 
     /***************************************************************************
       clear CPU interrupts
     ***************************************************************************/
     IER = 0;
     ICR = 0xFFFF;
     CSR &= ~1;
 
 }

void BoardDisableEDMA ( void )

 {
 //    CSL_Edma3ccRegsOvly Edma3cc0Regs = (CSL_Edma3ccRegsOvly)CSL_EDMA3CC_0_REGS;
 
 //    Edma3cc0Regs->IECR   = 0xffffffff;   // IER  - Disable interrupts
 //    Edma3cc0Regs->EECR   = 0xffffffff;   // EER  - Disable events
 //    Edma3cc0Regs->ICR    = 0xffffffff;   // ICR  - Clear interrupts
 //    Edma3cc0Regs->ECR    = 0xffffffff;   // ICRH - Clear events
 }

int InitializeNetwork ( uint16_t icmp_size )

Parameters

icmp_size - space for ICMP (ping))

Returns: 0 - success or >0 - error occurred

Examples:: Blocksend.c, Chat.c, DHCPTest.c, DNSTest.c, Echo.c, FTPClient.c, FTPServer.c, HTTPdynamic.c, HTTPjava.c, HTTPsimple.c, Multicast.c, NetTest.c, Ping.c, Ping2.c, PServer.c, Receive.c, Send.c, SMTP.c, SNTPTest.c, and Telnet.c.

 {
     /***************************************************************************
       locals
     ***************************************************************************/
     uint16_t buffer[3];
     char uid[6];
     static uint32_t NetInitStatus = 0;  // not initialized
 
 
     if (NetInitStatus) return (0);
 
     /***************************************************************************
      initialize DM642 EMAC
       possible values
       mode: FDX_100, FDX_10, HDX_100, HDX_10, AUTO_NEG
       MAC Address
       link_status: callback function or NULL
     ***************************************************************************/
     if ( !DM2_EmacInit (eth.mode, eth.mac, link_status) )
     {
 #ifdef EMAC_DETAIL
         return (1);
 #else
         prg_exit ("\r\nDM2_EmacInit() function failed\r\nEthernet defect");        /* initialize EMAC error */
 #endif
     }
 
 
     /***************************************************************************
      in case of DHCP create unique network name
     ***************************************************************************/
     if (!((eth.ip[0]-'0')<=9))
     {
         /***********************************************************************
          read internal MAC address
         ***********************************************************************/
         get_mac_address (0, buffer);
 
         if ( strlen(eth.ip) < (30-5) ) // check space for MAC ID
         {
             /*******************************************************************
              append lower MAC address bits to module name for unique host name.
              eth.ip is defined in netconfig.c as a 30 byte char array. Don't
              use host names larger than 30 bytes or increase the array size.
             *******************************************************************/
             sprintf (uid, "-%04X", htons(buffer[2]));
             strcat (eth.ip, uid);
         }
         else
         {
 #ifdef EMAC_DETAIL
             return (2);
 #else
             prg_exit ("\r\nhostname too long");      /* initialize EMAC error */
 #endif
         }
     }
 
     /***************************************************************************
      init sockets
             1. parameter:       own IP address or own HOST_NAME
             2. parameter:       subnet mask
             3. parameter:       gateway address
             4. parameter        NULL       - own IP address is valid
                                 DHCP_ENABLE - IP comes from a DHCP Server
                                               own HOST_NAME is valid
             5. parameter        DNS Server IP or NULL
             6. parameter        DNS_ENABLE or NULL
     ***************************************************************************/
     if ( !net_init (eth.ip,
                     eth.subnet_mask,
                     eth.gateway,
                     eth.dhcp_setting,
                     eth.dns,
                     eth.dns_setting))
     {
 #ifdef EMAC_DETAIL
         return (3);
 #else
         prg_exit ("net_init() failed"); /* out of memory, try to increase heap */
 #endif
     }
 
     /***************************************************************************
      in case of DHCP reset IP address
     ***************************************************************************/
     if (!((eth.ip[0]-'0')<=9))
     {
         set_ip_address (0, "0.0.0.0");
     }
 
     /***************************************************************************
       install icmp socket (for ping)
     ***************************************************************************/
     if ( (icmp_so = install_icmp_socket (icmp_size)) == NULL)
     {
 #ifdef EMAC_DETAIL
         return (4);
 #else
         prg_exit ("ICMP socket error");         /* possibly insufficient heap */
 #endif
     }
 
     NetInitStatus = 1;  // network initialized
 
     /***************************************************************************
       success
     ***************************************************************************/
     return (0);
 }

int BoardUartInit ( void )

Parameters

-

Returns: 0 - success !0 - error

Examples:: BoardSpecific.c.

void BoardUartWriteString ( const char * str )

Parameters

str	- string to write

Returns: -

Examples:: BoardSpecific.c.

int BoardUartWriteFormattedString	(	const char *	format,
			...
	)

Parameters

format - format string to write

Returns: -

Examples:: BoardSpecific.c.

int32_t BoardUartWriteChar ( char c )

Parameters

c	- character to write

Returns: true (1) if successful, false (0) if transmitter not ready

Examples:: BoardSpecific.c.

int32_t BoardUartReadChar ( char * c )

Parameters

c	- pointer to character storage

Returns: true (1) if successful, false (0) if receiver empty

Examples:: BoardSpecific.c, and FTPClient.c.

char* BoardUartReadString	(	char *	dst,
		size_t	maxlen,
		uint32_t	timeout,
		int32_t	echo
	)

Parameters

dst	- pointer to destination buffer
maxlen	- maximum string length (size of destination buffer) in bytes
timeout	- number of retries until data is received, 0 = no timeout
echo	- echo received characters

Returns: pointer to destination buffer, 0 if timeout

Note: This function reads an ASCIIZ string from the UART. If a line end character (CR and/or LF)is received or maxcount is reached, a terminating 0 is appended and the function returns. Line end characters are skipped from the string. BACKSPACE deletes the previous character from the string. ESC terminates and returns an empty string.; all line end characters are accepted (CR, LF, CR+LF); This function uses a global variable to store the last line end character - it is not re-entrant-safe; Echo requires a full-duplex UART line interface, not supported with RS485; This is a blocking function !

Examples:: BoardSpecific.c.

int BoardInitializeTimer	(	uint32_t	timer_clock,
		int	port,
		uint32_t	utime
	)

Parameters

timer_clock	- PLL configured clock speed (in MHz)
port	- timer port
utime	- desired timer frequency in u-seconds

Returns: false - success true - timer frequency not accessible

Examples:: BoardSpecific.c.

void BoardPlugTimerHandler	(	int32_t	cpuint,
		int	port,
		void(*)(void)	eventTimerHandler
	)

Parameters

cpuint	- CPU interrupt
port	- timer port
eventTimerHandler	- timer interrupt handler

Returns: -

Examples:: BoardSpecific.c.

void BoardStartTimer ( int port )

Parameters

port	- timer port

Returns: -

Examples:: BoardSpecific.c.

void BoardStopTimer ( int port )

Parameters

port	- timer port

Returns: -

Examples:: BoardSpecific.c.

void LED_init ( )

Function LED_init

Turn all LEDs off

Parameter Returns Calls

Examples:: Multicast.c.

 {
     ledstate = 0;
 }

void LED_off ( unsigned int ledNum )

Function LED_off

Parameter Returns Calls

Examples:: Blocksend.c, HTTPdynamic.c, HTTPjava.c, Multicast.c, and Send.c.

 {
     /* Check bounds for ledNum */
     if (ledNum >= 4)
         return;
     /* Clear the LED bit */
     ledstate &= ~(1 << ledNum);
 }

void LED_on ( unsigned int ledNum )

Function LED_on

Parameter Returns Calls

Examples:: Blocksend.c, HTTPdynamic.c, HTTPjava.c, Multicast.c, NetTest.c, Ping2.c, Send.c, and SNTPTest.c.

 {
     /* Check bounds for ledNum */
     if (ledNum >= 4)
         return;
     /* Set the LED bit */
     ledstate |= (1 << ledNum);
 }

void LED_toggle ( unsigned int ledNum )

Function LED_toggle

Parameter Returns Calls

Examples:: Ping2.c, Send.c, and SNTPTest.c.

 {
     unsigned int led_mask = 1 << (ledNum);
     /* Check bounds for ledNum */
     if (ledNum >= 4)
         return;
     /* Set the LED bit */
     if ( ledstate & led_mask )
         LED_off(ledNum);
     else
         LED_on(ledNum);
 }

uint16_t LED_state ( void )

Function LED_state

Parameter Returns Calls

Examples:: HTTPdynamic.c, and HTTPjava.c.

 {
     return (ledstate);
 }

void KEY_init ( void )

Function KEY_init

 {
     //~ keystate = 0;
     /***************************************************************************
      Initialize KEYs
     ***************************************************************************/
 }

int KEY_pressed ( unsigned int keyNum )

Function KEY_pressed

Examples:: FTPClient.c.

 {
     UNREFERENCED_PARAMETER(keyNum);
     /* Check bounds for keyNum */
     //~ if ((keyNum >= SW1) && (keyNum <= SW0) )
         //~ return ( EZDSP5502_I2CGPIO_readLine (keyNum) == 0);
     //~ else
         return 0;
 
 }