# 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.


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

# Xtensa Tools location <xtensa_tools_root>
XTTOOLS = /././home/xpgcust/tree/RG-2017.5/tools/swtools-x86-linux
XTTOOLS_TOOLS = /././usr/xtensa/tools-7.0

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

# gcc/g++ versions 4.1.X and 4.4.X are supported 
CC = gcc
CXX = g++

# Several variants of XTMP/ISS libraries are provided inside XTTOOLS:
# lib/iss            contains 32-bit libraries compatible with gcc/g++ 4.4.X
# lib/iss-GCC-4.1    contains 32-bit libraries compatible with gcc/g++ 4.1.X
# lib64/iss          contains 64-bit libraries compatible with gcc/g++ 4.4.X
# lib64/iss-GCC-4.1  contains 64-bit libraries compatible with gcc/g++ 4.1.X

# By default, 32-bit libraries are used.
# Uncomment the following line to use 64-bit libraries.
# USE_64BIT = true

ifneq ($(findstring 4.1.,$(shell $(CC) -dumpversion)),)
SUFFIX_GCC = -GCC-4.1
endif

ifdef USE_64BIT
ifneq ($(findstring x86_64,$(shell $(CC) -dumpmachine)),)
XTTOOLS_TOOLS = /././usr/xtensa/tools-7.0-64
SUFFIX_64 = 64
TC_FLAGS = -x86_64
else
$(error $(CC) cannot build 64-bit executables)
endif
endif

LIB = lib$(SUFFIX_64)
ISSLIBDIR = iss$(SUFFIX_GCC)

ifeq ($(SUFFIX_GCC),)
GCC_LIBDIR = $(XTTOOLS_TOOLS)/$(LIB)
GCC_LIBS = -L$(GCC_LIBDIR) -Wl,-rpath $(GCC_LIBDIR)
else
# If you are using gcc from a non-standard location, and you don't set
# LD_LIBRARY_PATH, you may need to specify the location of gcc libraries
# GCC_LIBDIR = 
# GCC_LIBS = -L$(GCC_LIBDIR) -Wl,-rpath $(GCC_LIBDIR)
endif

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

# SystemC 2.2 location
SYSTEMC = $(XTTOOLS_TOOLS)/systemc
SYSTEMC_INCLUDE = $(SYSTEMC)/include
SYSTEMC_LIB = $(SYSTEMC)/lib-linux$(SUFFIX_64)$(SUFFIX_GCC)/libsystemc.a

# QuickThreads package
QT_DIR = $(XTTOOLS_TOOLS)
QT_INCLUDE = $(QT_DIR)/include
QT_LIB = $(QT_DIR)/$(LIB)/libqt.a

#==================================================================#
# 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)
# The precompiled driver is in $(XTTOOLS)/$(LIB)/$(ISSLIBDIR)/sysc_driver.so 
MP_DRIVER = sysc_driver.$(OBJ)
else
# The precompiled driver is in $(XTTOOLS)/$(LIB)/$(ISSLIBDIR)/qt_driver.so 
MP_DRIVER = qt_driver.$(OBJ)
endif

LD = $(CXX)
OPT = -g
# OPT = -O2 for optimized build
ifeq ($(SUFFIX_64),64)
ARCH_FLAG = -m64 -fPIC
else
ARCH_FLAG = -m32
endif
WARN = -Wall
# WARN = -w      for no warnings
# WARN = -Wextra for more warnings
COMPILE_ONLY = -c
INC_FLAG = -I
INCLUDES = -I $(XTTOOLS)/include
DEFINES = -DXTENSA_SYSTEM=\"$(XTENSA_SYSTEM)\" -DXTENSA_CORE=\"$(XTENSA_CORE)\"
CFLAGS  = $(OPT) $(ARCH_FLAG) $(WARN) $(INCLUDES)
LDFLAGS = $(OPT) $(ARCH_FLAG)
LDOUT = -o 
EXE = 
OBJ = o
RMDIR = rm -rf
RM = rm -rf

XTMP_OBJS = xtmp_options.$(OBJ) getopt.$(OBJ)

XTMP_LIBS = -L$(XTTOOLS)/$(LIB)/$(ISSLIBDIR) -lxtmp \
            -Wl,-rpath $(XTTOOLS)/$(LIB)/$(ISSLIBDIR) \
            -Wl,-rpath $(XTTOOLS)/$(LIB) \
            $(GCC_LIBS)

ifeq ($(USE_SYSTEMC),true)
LIBS = $(XTMP_OBJS) $(XTMP_LIBS) $(SYSTEMC_LIB) 
else
LIBS = $(XTMP_OBJS) $(XTMP_LIBS) $(QT_LIB) 
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 $@ $<

%_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.
qt_driver.$(OBJ): $(XTTOOLS)/src/iss/qt_driver.c
	$(CC) $(CFLAGS) $(COMPILE_ONLY) -I$(QT_INCLUDE) $<

# 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)

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)

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)

# 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)

# TIE group example (Section 4.1)
tieGroups_iss$(EXE): tieGroups_iss.$(OBJ) $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)

# 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)

# 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)

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)

# 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)

# 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)

# 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)

# 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)

# 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)

# 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)

# Example to demonstrate RCW
readCondWrite_iss$(EXE): readCondWrite_iss.$(OBJ) rcw.out $(MP_DRIVER) $(XTMP_OBJS)
	$(LD) $(LDFLAGS) $(LDOUT)$@ $< $(MP_DRIVER) $(LIBS)

# 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)

# 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)


.PHONY: clean
clean:
	-$(RMDIR) byte_disable_tdk divide_lookup_tdk export_import_tdk queue_tdk 
	-$(RM) $(EXAMPLES) *.out *.$(OBJ) *.dis *~ \#* *.log

