# Makefile for building XTMP examples 

# Customer ID=7729; Build=0x71521; Copyright (c) 2003-2013 Tensilica Inc.  ALL RIGHTS RESERVED.
# 
# These coded instructions, statements, and computer programs are the
# copyrighted works and confidential proprietary information of
# Tensilica Inc.  They may be adapted and modified by bona fide
# purchasers for internal use, but neither the original nor any adapted
# or modified version may be disclosed or distributed to third parties
# in any manner, medium, or form, in whole or in part, without the prior
# written consent of Tensilica Inc.


SHELL=cmd

#==================================================================#
# BEGIN:                                                           #
# VARIABLES YOU MAY WANT TO CHANGE BEFORE USING THIS MAKEFILE      #
#==================================================================#

# Xtensa Tools location <xtensa_tools_root>
XTTOOLS = C:\.\.\build\tree\RG-2017.5_kuma\tools\swtools-MSWin32-x86
XTTOOLS_TOOLS = C:\.\.\usr\xtensa\tools-7.0

# Xtensa core registry
ifndef XTENSA_SYSTEM
XTENSA_SYSTEM = $(XTTOOLS)\config
endif

# You can build these examples using either 
#   Microsoft Visual C++ 2010 (10.0). 
# or 
#   Microsoft Visual C++ 2012 (11.0). 
 
# To set the environment correctly, run vsvars32.bat
# included with Microsoft Visual Studio.
  
LIB_VARIANT = -UNKNOWN.MSVC.version
ifneq ($(findstring Compiler Version 16,$(shell cl 2>&1)),)
# Visual C++ 2010 uses Compiler (cl) Version 16
LIB_VARIANT = 
SYSTEMC_LIB = $(XTTOOLS_TOOLS\systemc)\msvc100\SystemC\$(BUILD)\SystemC.lib
endif
ifneq ($(findstring Compiler Version 17,$(shell cl 2>&1)),)
# Visual C++ 2012 uses Compiler (cl) Version 17
LIB_VARIANT = -vc110
SYSTEMC_LIB = $(XTTOOLS_TOOLS\systemc)\msvc110\SystemC\$(BUILD)\SystemC.lib
endif
ISSLIBDIR = iss$(LIB_VARIANT)

# You must also set the PATH variable to include
# XtensaTools bin and $(ISSLIBDIR) directories. 
# For Visual C++ 2010
#   set PATH=C:\.\.\build\tree\RG-2017.5_kuma\tools\swtools-MSWin32-x86\bin;C:\.\.\build\tree\RG-2017.5_kuma\tools\swtools-MSWin32-x86\lib\iss;%PATH%
# For Visual C++ 2012
#   set PATH=C:\.\.\build\tree\RG-2017.5_kuma\tools\swtools-MSWin32-x86\bin;C:\.\.\build\tree\RG-2017.5_kuma\tools\swtools-MSWin32-x86\lib\iss-vc110;%PATH%

# Choose Release or Debug build; default is Release
BUILD = Release
# BUILD = Debug

# By default, Windows fibers are used for XTMP core and user threads.
# Uncomment the following line if you want to use SystemC 2.2
# USE_SYSTEMC = true

# SystemC 2.2 location
SYSTEMC = $(XTTOOLS_TOOLS)\systemc
SYSTEMC_INCLUDE = $(SYSTEMC)\src

#==================================================================#
# END:                                                             #
# VARIABLES YOU MAY WANT TO CHANGE BEFORE USING THIS MAKEFILE      #
#==================================================================#

# Name of the Xtensa processor core
XTENSA_CORE = hifi3_hikey960

# Files required by XTMP main program

ifeq ($(USE_SYSTEMC),true)
MP_DRIVER = sysc_driver.$(OBJ)
else
MP_DRIVER = fiber_driver.$(OBJ)
endif


CC = cl
LD = link
MT = mt -nologo
ifeq ($(BUILD),Release)
OPT = /O2
DBG =
LDEBUG =
else
OPT = /Od /Zi
DBG = d
LDEBUG = /debug
endif
WARN = /W3 /wd4996
COMPILE_ONLY = /c
INC_FLAG = /I
INCLUDES = /I $(XTTOOLS)\include
DEFINES = /DXTENSA_SYSTEM=\"$(subst \,/,$(XTENSA_SYSTEM))\" /DXTENSA_CORE=\"$(XTENSA_CORE)\"
CFLAGS = /nologo /vmg /EHsc /GS- $(OPT) /MD$(DBG) $(WARN) $(INCLUDES)
LDFLAGS = /nologo /subsystem:console /manifest $(LDEBUG)
LDOUT = /out:
EXE = .exe
OBJ = obj
RM = del /q
RMDIR = rmdir /q /s
XTMP_OBJS = xtmp_options.$(OBJ) getopt.$(OBJ)
XTMP_LIBS = $(XTTOOLS)/lib/$(ISSLIBDIR)/xtmp$(DBG).lib

ifeq ($(USE_SYSTEMC),true)
LIBS = $(XTMP_OBJS) $(XTMP_LIBS) $(SYSTEMC_LIB)
else
LIBS = $(XTMP_OBJS) $(XTMP_LIBS)
endif


QUEUE_EXE = queue_iss$(EXE) builtinQueue_iss$(EXE)
TIEPORTS_EXE = tiePorts_iss$(EXE)
LOOKUP_EXE = 

EXAMPLES = \
	up_iss$(EXE) \
	mp_iss$(EXE) \
	regtest_iss$(EXE) \
	peekpoke_iss$(EXE) \
	tieGroups_iss$(EXE) \
	$(TIEPORTS_EXE) \
	$(QUEUE_EXE) \
	$(LOOKUP_EXE) \
	forward_iss$(EXE) \
	localMemDevice_iss$(EXE) \
	pifMemDevice_iss$(EXE) \
	inbound_iss$(EXE) \
	event_iss$(EXE) \
	simModeSwitch_iss$(EXE) \
	byteDisable_iss$(EXE) \
	readCondWrite_iss$(EXE) \
	multClock_iss$(EXE) \


.PHONY: all
all: $(EXAMPLES)

%.$(OBJ) : %.c
	$(CC) $(CFLAGS) $(DEFINES) $(COMPILE_ONLY) $<

XCC = $(XTTOOLS)/bin/xt-xcc 
XCCFLAGS = -g

%.out: %.c
	$(XCC) --xtensa-core=$(XTENSA_CORE) $(XCCFLAGS) -o $@ $<

%: %.c
	@echo You should make $@$(EXE) instead.

%_tdk: %.tie
	$(XTTOOLS)/bin/tc $(TC_FLAGS) --xtensa-core=$(XTENSA_CORE) -d $@ $<

# Compile sysc_driver.cxx, the top-level program for XTMP that uses
# System-C as the thread package.
# Feel free to copy sysc_driver.cxx and modify it yourself
# You can also link in the pre-compiled version of sysc_driver.so
sysc_driver.$(OBJ): $(XTTOOLS)/src/iss/sysc_driver.cxx
	$(CC) $(CFLAGS) $(COMPILE_ONLY) $(INC_FLAG) $(SYSTEMC_INCLUDE) $<

# Compile either qt_driver.c or fiber_driver.c, the top-level program 
# for XTMP that use QT and NT fibers as the thread package, respectively.
# Feel free to copy qt_driver.c or fiber_driver.c and modify it yourself.
# You can also link in the pre-compiled version.
fiber_driver.$(OBJ): $(XTTOOLS)/src/iss/fiber_driver.c
	$(CC) $(CFLAGS) $(COMPILE_ONLY) $<

# Uniprocessor example (Section 2.7.1)
up_iss$(EXE): up_iss.$(OBJ) sieve.out sieve_long.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

sieve_long.out: sieve.c
	$(XCC) --xtensa-core=$(XTENSA_CORE) $(XCCFLAGS) -DITERS=1000 -o $@ $<
	
# Multiprocessor example (Section 2.7.2)
mp_iss$(EXE): mp_iss.$(OBJ) producer.out consumer.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

producer.out: mp_sync.c
	$(XCC) --xtensa-core=$(XTENSA_CORE) $(XCCFLAGS) -DPRODUCER -o $@ $<

consumer.out: mp_sync.c
	$(XCC) --xtensa-core=$(XTENSA_CORE) $(XCCFLAGS) -DCONSUMER -o $@ $<

# Register test example (Section 3.2.2)
regtest_iss$(EXE): regtest_iss.$(OBJ) empty.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

# Peek/Poke example (Sections 3.2.4 and 5.4)
peekpoke_iss$(EXE): peekpoke_iss.$(OBJ) empty.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

# TIE group example (Section 4.1)
tieGroups_iss$(EXE): tieGroups_iss.$(OBJ) $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

# TIE port example: export state, import wire (Sections 4.2.1 and 4.2.2)
export_import.out: export_import.c export_import_tdk
	$(XCC) --xtensa-core=$(XTENSA_CORE) --xtensa-params=export_import_tdk $(XCCFLAGS) -o $@ $<

tiePorts_iss$(EXE): tiePorts_iss.$(OBJ) export_import.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

# TIE queue examples (Sections 4.3 and 4.4)
queue_reader.out: queue_reader.c queue_tdk
	$(XCC) --xtensa-core=$(XTENSA_CORE) --xtensa-params=queue_tdk $(XCCFLAGS) -o $@ $<

queue_writer.out: queue_writer.c queue_tdk
	$(XCC) --xtensa-core=$(XTENSA_CORE) --xtensa-params=queue_tdk $(XCCFLAGS) -o $@ $<

queue_reader_long.out: queue_reader.c queue_tdk
	$(XCC) --xtensa-core=$(XTENSA_CORE) --xtensa-params=queue_tdk $(XCCFLAGS) -DITERS=1000 -o $@ $<

queue_writer_long.out: queue_writer.c queue_tdk
	$(XCC) --xtensa-core=$(XTENSA_CORE) --xtensa-params=queue_tdk $(XCCFLAGS) -DITERS=1000 -o $@ $<

queue_iss$(EXE): queue_iss.$(OBJ) queue_reader.out queue_writer.out queue_reader_long.out queue_writer_long.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

builtinQueue_iss$(EXE): builtinQueue_iss.$(OBJ) queue_reader.out queue_writer.out queue_reader_long.out queue_writer_long.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

# Transaction forwarding example (Section 5.5.1)
forward_iss$(EXE): forward_iss.$(OBJ) sieve.out sieve_long.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

# Custom local memory device example (Section 5.8)
localMemDevice_iss$(EXE): localMemDevice_iss.$(OBJ) sieve.out sieve_long.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

# Inbound PIF example (Section 5.9.1)
inbound_iss$(EXE): inbound_iss.$(OBJ) inbound.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

# Custom PIF memory device example (Section 6.4.1)
pifMemDevice_iss$(EXE): pifMemDevice_iss.$(OBJ) sieve.out sieve_long.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

# Event synchronization example (Section 6.4.2)
event_iss$(EXE): event_iss.$(OBJ) event.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

# Byte disable example
byte_disable.out: byte_disable.c byte_disable_tdk
	$(XCC) --xtensa-core=$(XTENSA_CORE) --xtensa-params=byte_disable_tdk $(XCCFLAGS) -o $@ $<

byteDisable_iss$(EXE): byteDisable_iss.$(OBJ) byte_disable.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

# Example to demonstrate RCW
readCondWrite_iss$(EXE): readCondWrite_iss.$(OBJ) rcw.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

# Example to illustrate cores simulating in multiple clock domains
multClock_iss$(EXE): multClock_iss.$(OBJ) producer.out consumer.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest

# Simulation mode switching example (Section 7.7)
simModeSwitch_iss$(EXE): simModeSwitch_iss.$(OBJ) sieve_long.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)
	$(MT) -manifest $@.manifest '-outputresource:$@;1'
	$(RM) $@.manifest


.PHONY: clean
clean:
	-$(RMDIR) byte_disable_tdk divide_lookup_tdk export_import_tdk queue_tdk 
	-$(RM) $(EXAMPLES) *.out *.$(OBJ) *.dis *~ \#* *.log
	-$(RM) $(XTMP_OBJS) *.idb *.pdb *.ilk *.exp *.ncb *.manifest

