1.1 運(yùn)行控制 API 接口
SIM_init()
聲明:void SIM_init()
功能說明:調(diào)用 SIM_init 初始化 Simulator,SIM_init 負(fù)責(zé)做以下初始化工作:
初始化核心庫中的所有數(shù)據(jù)結(jié)構(gòu)
根據(jù)設(shè)置的動態(tài)庫加載路徑,加載各種模塊
參數(shù):無
返回值:無
SIM_start()
功能說明:根據(jù)配置文件,設(shè)置特定的數(shù)據(jù)結(jié)構(gòu),為運(yùn)行做好準(zhǔn)備,。
參數(shù):
返回值:
SIM_run()
功能說明:啟動目標(biāo)機(jī)器
參數(shù):無
返回值:
SIM_stop(generic_core_t* core)
功能說明:停止目標(biāo)機(jī)器
參數(shù):指定的處理器核心
返回值:無
SIM_continue(generic_core_t* core)
功能說明:
參數(shù):
返回值:

1.2 命令行接口 API
add_command
聲明:exception_t add_command(char* command_str, rl_icpfunc_t* func, const char* help_str);
功能說明:添加一個新的命令到命令行接口中,。
參數(shù):command_str 為命令的字符串,func 為執(zhí)行命令時(shí)要調(diào)用的函數(shù),help_str 是命令的幫助文檔,。
返回值:成功返回 No_exp,錯誤則返回相應(yīng)異常的類型,。

1.3 回調(diào)函數(shù)接口 API
register_callback
聲明: exception_t register_callback(callback_func_t func, callback_kind_t kind);
功能說明:注冊一個新的回調(diào)函數(shù)到系統(tǒng)中,。
參數(shù):func 為要執(zhí)行的回調(diào)函數(shù),kind 是回調(diào)函數(shù)的類型。
返回值:成功返回 No_exp,錯誤則返回相應(yīng)異常的類型,。

1.4 配置文件接口 API
get_current_config
聲明:skyeye_config_t* get_current_config();
功能:獲得當(dāng)前的配置文件的數(shù)據(jù)結(jié)構(gòu)
參數(shù):無
返回值:當(dāng)前配置文件的數(shù)據(jù)結(jié)構(gòu)
skyeye_read_config
聲明:exception_t skyeye_read_config (char* conf_filename);
功能:加載并解析相應(yīng)的 skyeye 配置文件,保存在內(nèi)存中,。
參數(shù):配置文件的文件名。
返回值:成功返回 No_exp,錯誤則返回相應(yīng)的異常類型,。
register_option
聲明:exception_t register_option(char* option_name, do_option_t do_option_func, char* helper);
功能:注冊新的配置文件選項(xiàng)到系統(tǒng)中,。
參數(shù): option_name 是配置選項(xiàng)的名稱,do_option_func 是用來解析配置選項(xiàng)的函數(shù),helper 是該配置選
項(xiàng)的幫助文本。
返回值:成功則返回 No_exp,錯誤則返回相應(yīng)的異常類型

1.5 uart 相關(guān)的 API
skyeye_uart_write
聲明:
int skyeye_uart_write(int devIndex, void *buf, size_t count, int *wroteBytes[MAX_UART_DEVICE_NUM]);
功能 說 明:
提供給虛擬串口硬件調(diào)用,可以把數(shù)據(jù)寫入底層的物理接口模塊中,。
參數(shù):
返回值:
skyeye_uart_read
聲明:
int skyeye_uart_read(int devIndex, void *buf, size_t count, struct timeval *timeout, int *retDevIndex);
功能 說 明 :提供給虛擬串口硬件調(diào)用,可以把數(shù)據(jù)寫入底層的物理鏈接層模塊中,。

1.6 模塊相關(guān)的 API
skyeye_load_all_module
聲明: void skyeye_load_all_module(const char* lib_dir, char* lib_suffix);
功能描述:
參數(shù):
返回值:
skyeye_load_module
聲明:exception_t SKY_load_module(const char* module_filename);
功能描述:
參數(shù):
返回值:

1.7 內(nèi)存訪問相關(guān)的 API
bus_read
聲明: int bus_read(short size, int addr, uint32_t * value);
功能描述:
參數(shù)
返回值:
bus_write
聲明: int bus_write(short size, int addr, uint32_t value);
功能描述:從總線上寫一個數(shù)據(jù)到某一個地址單元中。
參數(shù):size 用來指定寫數(shù)據(jù)的長度,addr 為寫入的地址的值,value 為寫入的數(shù)據(jù),。
返回值:
addr_mapping
聲明:exception_t addr_mapping(mem_bank_t* bank);
功能描述:addr_mapping 接口用來申請一段地址空間,并來控制這段地址空間的訪問,。
參數(shù) :bank,是客戶需要分配和填充的一個數(shù)據(jù)接口,定義如下:

typedef struct mem_bank
{
unsigned int addr, len;
char (*bank_write)(short size, int offset, unsigned int value);
char (*bank_read)(shortsize, int offset, unsigned int *result);
char filename[MAX_STR];
/* the name of object mapping to the bank */
char* objname;
unsigned type;
} mem_bank_t;

Mem_bank_t 的域 addr 是這段地址空間的起始地址,len 為這段地址空間的長度。
Bank_write 和 bank_read 分別為這段地址的讀寫函數(shù),。當(dāng)目標(biāo)程序?qū)@段地址空間進(jìn)行訪問
的時(shí)候,SkyEye 會調(diào)用這段地址空間對應(yīng)的 bank_write 和 bank_read 進(jìn)行訪問,。
Filename 為加載的文件,在初始化這段地址空間的時(shí)候,SkyEye 可以把一個數(shù)據(jù)文件加載
到這段地址空間去。
objname 是一個字符串,用來標(biāo)志一個對象的名稱,。
type 是這段地址空間的類型,有只讀內(nèi)存,可讀寫內(nèi)存和 IO 這三種類型,。
返回值:可能發(fā)生的異常類型。

1.8 機(jī)器管理的 API
register_mach
聲明:void register_mach(char* mach_name, mach_init_t mach_init);
功能描述:注冊一個模擬的機(jī)器或者單板到系統(tǒng)中,。
參數(shù):
返回值:無
get_mach
聲明:machine_config_t * get_mach(const char* mach_name);
功能描述:獲得一個機(jī)器或者單板的數(shù)據(jù)結(jié)構(gòu)
參數(shù):機(jī)器的名稱
返回值:模擬的機(jī)器的數(shù)據(jù)結(jié)構(gòu)
send_signal
聲明:exception_t send_signal(interrupt_signal_t* signal);
功能描述:向某一個處理器發(fā)出中斷信號,一般外設(shè)會調(diào)用此接口,。
參數(shù):信號的類型和電平。interrupt_signal_t 的定義如下:

typedef union interrupt_signal{
arm_signal_t arm_signal;
mips_signal_t mips_signal;
powerpc_signal_t powerpc_signal;
}interrupt_signal_t;

它是一個聯(lián)合,為不同的體系結(jié)構(gòu)定義了不同的信號的結(jié)構(gòu)體,。
返回值:可能發(fā)生的異常類型,。

1.9 事件調(diào)度器的相關(guān)的 API
create_thread_scheduler
聲明:int create_thread_scheduler(unsigned int ms, sched_mode_t mode, sched_func_t func, void *arg,
int *id);
功能說明:創(chuàng)建一個線程控制調(diào)度的事件,并放入調(diào)度隊(duì)列中。輸入該事件發(fā)生的相對事件,是否是周期發(fā)
生模式,響應(yīng)函數(shù),函數(shù)參數(shù),一個整形指針得到調(diào)度器分配的 ID,。
參數(shù):
ms 為事件發(fā)生的間隔時(shí)間;mode 表示是否是周期性事件(Oneshot_sched/Periodic_sched);
func 是事件處理函數(shù)的指針;arg 是處理函數(shù)的參數(shù)指針;id 表示獲取標(biāo)識的指針,。
返回值:成功會返回 No_exp,否則會返回錯誤信息。
mod_thread_scheduler
聲明:int mod_thread_scheduler(int id, unsigned int ms, sched_mode_t mode);
功能說明:修改調(diào)度隊(duì)列中指定標(biāo)識的事件。
參數(shù):id 為事件的標(biāo)識;ms 是事件的發(fā)生的間隔時(shí)間;mode 表示是否周期性事件
(Oneshot_sched/Periodic_sched),。
返回值:成功會返回 No_exp,否則會返回錯誤信息,。
del_thread_scheduler
聲明:int del_thread_scheduler(int id);
功能說明:刪除調(diào)度隊(duì)列中指定標(biāo)識的事件。
參數(shù):id 是事件的標(biāo)識,。
返回值:成功會返回 No_exp,否則返回錯誤信息。
fini_thread_scheduler
聲明:int fini_thread_scheduler(void);
功能說明:銷毀線程調(diào)度隊(duì)列,。
參數(shù):無
返回值:成功會返回 No_exp ,否則返回錯誤信息,。
list_thread_scheduler
聲明:void list_thread_scheduler(void);
功能說明:打印線程調(diào)度隊(duì)列中的所有事件及其屬性。
參數(shù):無
返回值:無
create_timer_scheduler
聲明:int create_timer_scheduler(unsigned int ms, sched_mode_t mode, sched_func_t func, void *arg,
int *id);
功能說明:創(chuàng)建一個定時(shí)器調(diào)度事件,并放入調(diào)度隊(duì)列中,。輸入該事件發(fā)生的間隔時(shí)間,、是否是周期發(fā)生模
式、響應(yīng)函數(shù),、函數(shù)參數(shù),、一個整形的指針得到調(diào)度器分配的 ID。
參數(shù):ms 為事件發(fā)生的間隔時(shí)間;mode 是否是周期性事件(Oneshot_sched/Periodic_sched);func 是事
件處理函數(shù)的指針;arg 是處理函數(shù)的參數(shù)指針;id 表示獲取標(biāo)識的指針,。
返回值:成功會返回 No_exp,否則返回錯誤信息,。
mod_timer_scheduler
聲明: int mod_timer_scheduler(int id, unsigned int ms, sched_mode_t mode);
功能說明: 修改調(diào)度隊(duì)列中指定標(biāo)識的事件。
參數(shù):Id 為事件的標(biāo)識;ms 是事件的發(fā)生的間隔時(shí)間;mode 表示是否周期性事件
(Oneshot_sched/Periodic_sched),。
返回值:成功會返回 No_exp , 否則返回錯誤信息,。
del_timer_scheduler
聲明:int del_timer_scheduler(int id);
功能說明: 刪除指定標(biāo)識的定時(shí)器事件。
參數(shù):id,事件標(biāo)識,。
返回值:成功會返回 No_exp,否則返回錯誤信息,。
fini_timer_scheduler
聲明:int fini_timer_scheduler(void);
功能說明:銷毀定時(shí)器調(diào)度隊(duì)列。
參數(shù):無,。
返回值:成功會返回 No_exp,否則返回錯誤信息,。
list_timer_scheduler
聲明:void list_timer_scheduler(void);
功能說明:打印定時(shí)器調(diào)度隊(duì)列中的所有事件及其屬性
。 參數(shù):無
返回值:無