1. Up-to-date Function Summary

Note that this section is a result of plenty of cut&paste work. It is, therefore, quite messy.

1.1 view.c

• GtkWidget* view_create_h_mov_split (void) - make a horizontal moveable split
• GtkWidget* view_create_v_mov_split (void) - make a vertical moveable split
• void view_create_mainwindow (void) - creates the main KMD main window
• GtkWidget* view_create_menubar(void) - creates the menu bar
• GtkWidget* view_create_filebar (void) - creates the file bar
• GtkWidget* create_featurewindow (void) - creates the features window
• GtkWidget* create_xfpgasegment (void) - the following creates a feature entry for the FPGA
• GtkWidget* view_create_comms (feature* console) - creates the console window/terminal in features
• void create_splashwindow (void) - creates the splash window (KMD logo)
• GtkWidget* create_aboutwindow (void) - creates the about window
• GtkWidget* view_create_prog_ctrl (void) - creates the control bar (where all the buttons and tick boxes are)
• GtkWidget* create_memorywindow (void) - creates the large memory window/s
• GtkWidget* view_create_memory_clist (void) - creates the smaller memory frames/regions in the right hand side of the screen
• GtkWidget* view_create_flag_frame(int regbanknumber) - creates flag frames for CPSR and SPSR
• GtkWidget* view_create_register_clist (int regbanknumber) - creates a register bank frame; inputs: the number of the register bank
• GtkWidget* view_create_console (void) - * creates console window (the main one at the bottom)
• GtkWidget* create_status_bar(void) - creates the status bar
• GtkWidget* view_parse_list(void) - Parses the display list from the .komodo file and invokes the functions that will construct the body of the main window

1.2 viewfuncs.c

• char* view_dis(uchar* address, uchar* code,int count, GList* isa) - Disassembles an instruction
• int view_updatememwindow(mem_window* memwindowptr) - Updates a memory window
• int view_updateregwindow(reg_window* regwindowptr) - Updates a register bank
• mem_window* view_getmemwindowptr(GtkWidget* widget) - Get the memory window pointer of a widget
• reg_window* view_getregwindowptr(GtkWidget* widget) - Get the register window pointer of a widget

1.3 interface.c

• void board_getcpuinfo(void) - Called from wotRu? function and uses board_cpu_reference_number from the board to initialise some values
• int board_ping(int start) - Checks if the board is still available and is the same version as before Board Ping is passed 1 if its the first time called in which case it will record board version. It Returns 0 if failed, 1 if successful
• int board_mini_ping(int start) - As above, just simpler and faster. Returns 0 if failed, 1 otherwise. start is 1 if this function is called for the first time. The output FIFO buffer is never cleared out unlike the above function
• int board_micro_ping(void) - see the above functions. This one is simpler, hence faster
• int board_enq(void) - Find the current execution state of the client. Returns: client response if stopped, running, error, else "BROKEN"
• int board_wotru(void) - * Gets the board information at the strt and returns 0 if failed
• int board_get_regbank (int regbanknumber) - Updates a given register bank on the screen gievn it's number. Returns 1 if successful, 0 otherwise
• int board_set_register(int regbanknumber, int registernumber, unsigned char *value) - Sets a register to a given value.
• int board_get_memory (int count, unsigned char* address, unsigned char* dest, int size) - Gets a memory value of a given address
• int board_set_memory (int count, unsigned char* address, unsigned char* sourc, int size) - Sets a memory value of a given address to a new value
• int main(int argc, char *argv[]) - Main function
• void commandline(int argc, char *argv[]) - command line arguments are processed here
• void setup() - Setting up the application. A subroutine called from main()

1.4 callbacks.c

• void callback_button_load (GtkButton* button, gpointer entry) - Called when load button pressed and loads an ELF file
• void callback_load_binary_address(GtkEntry* entry, gpointer label) - Loads a binary address
• void callback_load_binary(GtkButton* button, gpointer entry) - Loads a binary file as if it were an ELF file
• void callback_button_compile (GtkButton* button, gpointer entry) - Compiles a file
• void callback_button_ok_file(GtkButton* button, gpointer entry) - Confirms a file choice
• int callback_FPGA_header(uchar* buffer, gpointer container, unsigned int* size, int load) - Check output Xilinx bit file header
• void callback_fpgaload(GtkButton* button, gpointer container) - Complete download sequence to selected FPGA
• void callback_refresh_toggle_from_menu(gpointer ignore) - called when toggle refresh selected from menu entry
• void callback_fpgaupdate(GtkButton* button, gpointer container) - Load button pressed
• void callback_client_set_status(int running, int timer_value)
• void callback_button_start(GtkButton* button, gpointer steps) - start button pressed
• void callback_button_stop(GtkButton* button,gpointer ignore)
• void callback_button_continue(GtkButton* button, gpointer ignore)
• void callback_button_walk(GtkButton* button, gpointer steps)
• void callback_start_toggle(GtkToggleButton *togglebutton, gpointer user_data) - called when the check boxes in the control bar are pressed
• void callback_rtf_toggle (GtkToggleButton *togglebutton, gpointer user_data) - Called when service to interrupts is enabled or disabled
• void callback_refresh_toggle (GtkToggleButton *togglebutton, gpointer user_data) - Currently does nothing, but the state of the toggle button is inspected in other functions to enable the right behaviour
• void callback_button_ping (GtkButton* ignore, gpointer ignore2) - Called when the ping button is pressed or its entry in the menu is activated
• void callback_button_reset (GtkButton* ignore, gpointer ignore2) - reset button pressed or menu entry activated
• void callback_global_refresh(void) - Refresh all the memory lists and register banks
• void callback_memory_refresh(void) - Refresh all the memory lists one by one
• void callback_step_number(GtkEditable *editable, gpointer value) - called when the user changes the step number for multistep
• void callback_memwindow_length (GtkMenuItem* menuitem, gpointer newvalue) - A new representation for memory has been picked and new settings need to be taken into consideration
• void callback_set_memory_window_size(GtkMenuItem* menuitem, gpointer new_representation) - as above, only for memory window
• void callback_memwindow_isa (GtkMenuItem* menuitem, gpointer newvalue) - A new ISA description has been chosen from the selection menu e.g MIPS
• void callback_memwindow_listsize (GtkEditable *editable, gpointer ignore) - Change number of rows - a new value has now been selected to show more memory entries
• void callback_memwindow_ascii_toggle (GtkToggleButton* tbutton, gpointer ignore) - Display/hide ASCII column. Called when relevant toggle buttons are pressed
• void callback_memwindow_elf_symbols_toggle(GtkToggleButton* tbutton, gpointer ignore) - Called when check-box for elf symbols is pressed
• void callback_memwindow_dis_toggle (GtkToggleButton* tbutton, gpointer ignore) - Display/hide Disassembly column. Called when relevant toggle buttons are pressed
• void callback_memwindow_address (GtkEditable* editable, gpointer ignore) - Called when a new address is entered in a memory frame. Inputs: editable which is the address entry
• void scroll_display(mem_window* memwin, uchar* address) - Get "address"ed element onto display
• void callback_memwindow_hex (GtkEditable* editable, gpointer ignore) - Called when a new value is entered in the hex entry
• void callback_memwindow_ascii (GtkEditable* editable, gpointer ignore) - Takes ascii from editable and displays hex in the relevant region
• void callback_memwindow_dis (GtkEditable* editable, gpointer ignore) - Called when a new Disassembly is entered
• void callback_memwindow_scrollmove(GtkAdjustment *adjustment,gpointer ignore2) - Called when the adjustment widget is manipulated and scrolls memory accordingly
• void callback_memory_window_row_selected(GtkCList *clist, gint row, gint column,GdkEventButton *event,gpointer ignore) - a line in the memory window was selected
• void callback_memwindow_clist(GtkCList *clist, gint row, gint column, GdkEventButton *event,gpointer ignore) - a line in the column list representing the memory was pressed
• void callback_regwindow_hex (GtkEditable* editable,gpointer ignore) - The following is called when a new value has been put into a register
• void callback_regwindow_clist (GtkCList *clist, gint row, gint column, GdkEventButton *event, gpointer ignore) - Called when a row is pressed within any of the register banks column lists
• gint callback_walk(gpointer steps)
• void callback_comms(GtkEditable* entry, gpointer comms_console) - currently unused
• gint callback_update_comms(gpointer comms) - Updates the terminal given its reference and returns 1 to remain on the scheduler that invokes it every POLLING_PERIOD ms
• gint callback_updateall(gpointer ignore) - wrapper function to go from timer interrupts
• gint callback_update_memreg_window(int window_type, gpointer windowptr) - update either a register bank or a memory frame
• gint callback_updatememwindow(gpointer memwindowptr) - CURRENTLY UNREACHABLE - wrapper functions to go from timer interrupts and update memory
• gint callback_updateregwindow(gpointer regwindowptr) - CURRENTLY UNREACHABLE - wrapper functions to go from timer interrupts and update memory
• gint callback_console_update (gpointer data, gint source, GdkInputCondition condition) - Updates the console window
• void callback_flag_pressed(GtkToggleButton *togglebutton, gpointer user_data) - the following function will set or unset a flag i.e. change some bits in the CPSR (as a response to flag press)
• void callback_flag_pressed_saved(GtkToggleButton *togglebutton, gpointer user_data) - the following function will set or unset a flag i.e. change some bits in the SPSR (as a response to flag press)
• void callback_mode_selection(GtkMenuItem* menuitem, gpointer newmode) - The following is called when the user made a selection of current mode CPSR will get a new value depending on the mode chosen
• void callback_mode_selection_saved(GtkMenuItem* menuitem, gpointer newmode) - The following is called when the user made a selection of current mode SPSR will get a new value depending on the mode chosen
• void callback_mode_selection_all(int newmode, int PSR) - Generalises the above
• gint callback_console_keysnoop (GtkWidget *grab_widget, GdkEventKey *event, gpointer comms) - Traps a keypress and sends it to the terminal when appropriate
• void callback_clear_console(GtkButton* ignore,gpointer console) - Called when clear console is pressed
• void callback_mode_selected_from_menu(GtkWidget* ignore,gpointer mode_number) - Called when the user has selected new mode to be chosen in the register bank GTKNotebook
• void callback_flags_selected_from_menu(GtkWidget* ignore,gpointer mode_number) - Called when the user has selected new mode to be chosen in the flags GTKNotebook
• void callback_main_quit(gpointer ignore, gpointer ignore2) - The main exit routine. Close any open connections and/or files here
• void callback_memory_window_activated(gpointer ignore) - Called when the memory window becomes visible
• void callback_memory_window_hidden(gpointer ignore) - Called when the memorywindow becomes invisible

1.5 misc.c

• char* view_chararr2hexstrbe(int count, uchar* values) - Convert char array into hex string (big Endian)
• char* view_chararr2hexstr(int count, uchar* values) - Convert char array into hex string(little Endian)
• char* view_chararr2asciistr(int count, uchar* values) - Convert character array into printable string
• void view_chararrAdd(int count, uchar* byte_string, int number, uchar* acc) - New routine to service the two following entry points only "acc" may be the same as "byte_string"
• uchar* view_chararrAddint(int count, uchar* byte_string, int number) - Add number to byte_string of length count and return result in newly allocated memory
• void view_chararrAddintsame(int count, uchar* byte_string, int number) - Add number to byte_string of length count and return result in byte_string. MAY BE REMOVED AFTER REASSIGNING ALL CALLS TO "view_chararrAdd" ABOVE
• uchar* view_chararrAddchararr(int count, uchar* value1, uchar* value2) - Adds two input arrays of count bytes Result returned in newly allocated array of similar type
• int view_char_array_sub_char_arr_to_int(int count, uchar* value1, uchar* value2)
• long view_chararrSublong (int count, uchar* value1, long value2)
• int view_chararr2int(int count, uchar* input) - Accumulate count bytes from memory array (little endian) and return as int
• char* view_int2chararr(int count, int value) - Strip count bytes from value and place in memory (little endian)
• void view_chararrCpychararr(int count, uchar* source, uchar* destination) - Copy count characters from source to destination
• int view_hexstr2chararr(int length_of_result, char* passed_string, uchar* returned_unsigned_string) - Evaluate an input string and return a value as an array of bytes
• void remove_spaces(char* string) - Compress any spaces from passed string
• int view_findstrinarr(char* string, char** array, int arrcount) - Find string in an array of strings and return index of last numbered match
• int view_findstrinsymboltable(char* string, symbol* array, int arrcount) - Find string in a symbol table and return index. As above with different record format
• char* view_chararrinregbank(int count, uchar* value) - Search for a value in a register bank and return the name of the first register found. A '+' is appended if other registers have the same value.
• int get_Nth_bin_of_char(char hex_character, int bit_number) - Return the specified bit_number of ASCII representation in bit 0
• char nibble_to_ASCII(int value) - Convert a nibble to an ASCII character
• char byte_of_bits(int msbit, int bit2, int bit1, int lsbit) - the following function returns a byte representing the 4 bits
• char get_ascii_of_char_top_nibble(char character) - Given a character, according to the ASCII table, it will return the ASCII value of the top nibble, for instance, for 'A' it will return '4'
• char get_ascii_of_char_bottom_nibble(char character) - Given a character, according to the ASCII table, it will return the ASCII value of the bottom nibble, for instance, for 'A' it will return '1'
• int mask_one_byte(int hexadecimal_input) - Return just the least significant byte. Used for masking key_press

1.6 breakcalls.c (Glade)

• void breakpoint_toggled (GtkToggleButton *togglebutton, gpointer user_data)
• void breakpoint_select(GtkCList *clist, gint row, gint column, GdkEvent *event, gpointer user_data)
• void breakpoint_refresh (int brwc)
• void breakpoint_enterval (GtkEditable *editable, gpointer user_data)
• int trap_get_status(unsigned int trap_type, unsigned int *wordA, unsigned int *wordB)
• void trap_set_status(unsigned int trap_type, unsigned int wordA, unsigned int wordB)

1.7 breakview.c (Glade)

• GtkWidget* create_breakwindow (void)
• GtkWidget* create_simplebreakwindow (void)

1.8 emulcore.c

• int main() - the main processing loop
• int board_getchar(unsigned char *to_get) - get 1 char from board
• int board_sendchar(unsigned char to_send) - send 1 char to the board
• int board_sendbN(int value, int N) - Sends N bytes from the supplied value to the board, LSB first
• int board_getbN(int* val_ptr, int N) - Gets N bytes from the board into the indicated val_ptr, LSB first
• int board_getchararray(int char_number, unsigned char* data_ptr) - reads a character array from buffer
• int board_sendchararray(int char_number, unsigned char* data_ptr) - writes an array of bytes in the buffer

1.9 emulmips.c (not tested nor documented)

• void afterinstruction(uchar c)
• uchar* getwotrustring(void)
• void boardreset(void)
• uchar execute_instruction(void)
• unsigned int getreg(int number)
• void setreg(int number,unsigned int reg)
• unsigned int getmem32(int number)
• void setmem32(int number,unsigned int reg)

1.10 evaluate.c

Only the one relevant function is listed.

• unsigned int Evaluate(char **string, int *value, evaluation_data eval_data) - evaluates a given string in KMD

1.11 serial.c

• void serial_crash(void) - Frees up the serial line in case of a crash to avoid possible locking
• void serial_error(char *errorstring) - Frees up the serial line in case of an error during setup
• int serial_setup(int waittime) - Sets up the properties of the serial port connection
• int board_getchar(unsigned char *to_get) - get a single character/byte from the board using the general case of getting an array of bytes
• int board_sendchar(unsigned char to_send) - send a single character/byte to the board using the general case of sending an array of bytes
• int board_sendbN(int value, int N) - Sends N bytes from the supplied value to the board, LSB first
• int board_getbN(int* val_ptr, int N) - Gets N bytes from the board into the indicated val_ptr, LSB first
• int board_getchararray(int char_number, unsigned char* data_ptr) - Gets a character array from the board
• int board_sendchararray(int char_number, unsigned char* data_ptr) - Sends char_number bytes located at data_ptr to current client