# ====================================================================
#
#      hal_synth.cdl
#
#      Synthetic target architectural configuration data
#
# ====================================================================
## ####ECOSGPLCOPYRIGHTBEGIN####                                            
## -------------------------------------------                              
## This file is part of eCos, the Embedded Configurable Operating System.   
## Copyright (C) 1998, 1999, 2000, 2001, 2002, 2009 Free Software Foundation, Inc.
##
## eCos is free software; you can redistribute it and/or modify it under    
## the terms of the GNU General Public License as published by the Free     
## Software Foundation; either version 2 or (at your option) any later      
## version.                                                                 
##
## eCos is distributed in the hope that it will be useful, but WITHOUT      
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or    
## FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License    
## for more details.                                                        
##
## You should have received a copy of the GNU General Public License        
## along with eCos; if not, write to the Free Software Foundation, Inc.,    
## 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.            
##
## As a special exception, if other files instantiate templates or use      
## macros or inline functions from this file, or you compile this file      
## and link it with other works to produce a work based on this file,       
## this file does not by itself cause the resulting work to be covered by   
## the GNU General Public License. However the source code for this file    
## must still be made available in accordance with section (3) of the GNU   
## General Public License v2.                                               
##
## This exception does not invalidate any other reasons why a work based    
## on this file might be covered by the GNU General Public License.         
## -------------------------------------------                              
## ####ECOSGPLCOPYRIGHTEND####                                              
# ====================================================================
######DESCRIPTIONBEGIN####
#
# Author(s):      jskov
# Original data:  jskov
# Contributors:   bartv
# Date:           1999-11-01
#
#####DESCRIPTIONEND####
#
# ====================================================================

cdl_package CYGPKG_HAL_SYNTH {
    display  "Linux Synthetic target"
    doc           ref/hal-synth-arch.html
    parent        CYGPKG_HAL
    define_header hal_synth.h
    include_dir   cyg/hal
    requires      !CYGDBG_KERNEL_DEBUG_GDB_THREAD_SUPPORT
    
    description   "
        The Linux Synthetic Target HAL package provides the 
        support needed to run eCos binaries on top of a
        Linux kernel."

    implements    CYGINT_HAL_TESTS_NO_CACHES

    make {
        <PREFIX>/lib/target.ld: <PACKAGE>/src/synth.ld
        $(CC) -E -P -Wp,-MD,target.tmp -DEXTRAS=1 -xc $(INCLUDE_PATH) $(ACTUAL_CFLAGS) -o $@ $<
        @echo $@ ": \\" > $(notdir $@).deps
        @tail -n +2 target.tmp >> $(notdir $@).deps
        @echo >> $(notdir $@).deps
        @rm target.tmp
    }
    compile       synth_entry.c synth_diag.c synth_intr.c synth_syscalls.c

    define_proc {
        puts $::cdl_system_header "#define CYGBLD_HAL_TARGET_H   <pkgconf/hal_synth.h>"
    }

    # Real-time clock/counter specifics
    cdl_component CYGNUM_HAL_RTC_CONSTANTS {
        display       "Real-time clock constants."
        description   "
            In the synthetic target the system clock is implemented using
            Linux setitimer() and a SIGALRM signal. The PERIOD value is the
            number of microseconds between signals, the usec field of an
            itimerval structure. It should be a multiple of 10000 because
            Linux will not generate signals at a finer grain than that.
            The NUMERATOR and DENOMINATOR are derived from the period."
        flavor        none
    
        cdl_option CYGNUM_HAL_RTC_PERIOD {
            display       "Real-time clock period"
            flavor        data
            default_value 10000
	    requires	  { 0 == (CYGNUM_HAL_RTC_PERIOD % 10000) }
	    description "
                This option corresponds to the number of microseconds between
                clock interrupts."
        }
        cdl_option CYGNUM_HAL_RTC_NUMERATOR {
            display       "Real-time clock numerator"
            flavor        data
            calculated    CYGNUM_HAL_RTC_DENOMINATOR * 1000 * CYGNUM_HAL_RTC_PERIOD
        }
        cdl_option CYGNUM_HAL_RTC_DENOMINATOR {
            display       "Real-time clock denominator"
            flavor        data
            default_value 100
        }
    }
    # What to do when idling
    cdl_option CYGIMP_HAL_IDLE_THREAD_SPIN {
	display	"Spin when idle"
	default_value	CYGIMP_IDLE_THREAD_YIELD
	description "
            By default, whenever the eCos application enters the idle thread
            the synthetic target HAL will make a select() system call. Effectively
            this causes the application to block until an interrupt occurs,
            without consuming any cpu resources, as if the hardware supported
            some sort of IDLE instruction. Usually this behaviour is desirable.
            However it interferes with the emulation of some hardware. For
            example the synthetic watchdog timer device can use consumed cpu time
            rather than wallclock time to determine whether or not the watchdog
            has triggered, and if the process is spending nearly all its time
            blocked in select() then the watchdog will not trigger when it should.
            There are also some kernel configurations which require that the idle
            thread does not block."
    }
    requires	  { CYGIMP_IDLE_THREAD_YIELD implies CYGIMP_HAL_IDLE_THREAD_SPIN }
    
    cdl_option CYGBLD_LINKER_SCRIPT {
        display "Linker script"
        flavor data
	no_define
        calculated  { "src/synth.ld" }
    }

    cdl_option CYGSEM_HAL_SYNTH_TESTS {
        display       "Build the Synth HAL tests"
        default_value 0
        description   "
             The only test at the moment is disabled by default
             because it has to be run manually. It should be run both within 
             eCos and natively on Linux and the results compared"
    }

    cdl_component CYGPKG_HAL_SYNTH_TESTS {
        display       "Synth HAL tests"
        active_if     CYGSEM_HAL_SYNTH_TESTS
        flavor        data
        no_define
        calculated    { "tests/ftok.c" }
        
        make {
            <PREFIX>/tests/ftok: <PACKAGE>/tests/ftok.c
            @mkdir -p "$(dir $@)"
            @$(HOST_CC) -DHOST -g -O2 -o $@ $< || cc -DHOST -g -O2 -o $@ $< || -DHOST gcc -g -O2 -o $@ $<
        }
    }
}