PikeOS API reference in psswref.pdf

PikeOS integrated development environment CODEO contains internal help system. This help system contains a lot of useful information regarding PikeOS configuration. Unfortunately this help does not contain API reference. This makes impossible to use quick context help for obtaining reference for PikeOS-specific functions, definitions and data types. For example I was unable to fine reference for function “vm_cprintf” nor in CODEO context help, nor even by Google. Problem became more complicated because PikeOS distributive does not contain source files.

In order to solve this problem I recommend to use PikeOS pdf documentation from C:\sysgo\opt\pikeos-3.2\documentation path (in case of PikeOS installation to default directory). PikeOS specific API reference is contained in file “psswref.pdf” with title “PikeOS System Software Reference Manual”. PSSW is abbreviation for PikeOS System Software.

I created incomplete list of functions, common data types and definitions, described in this file. I hope that help someone to find way for required reference. For complete list of corresponding identifiers please inspect “psswref.pdf” file contents.

Functions

  • vm_close
  • vm_cmd_line
  • vm_cprintf
  • vm_cputs
  • vm_detach
  • vm_fp_listen
  • vm_fp_msg_dispatch
  • vm_fp_msg_init
  • vm_fp_msg_wait
  • vm_fstat vm_hm_attach
  • vm_hm_detach
  • vm_hm_error_handled
  • vm_hm_listen
  • vm_hm_raise_error
  • vm_init vm_ioctl
  • vm_lseek vm_malloc
  • vm_map vm_map_to
  • vm_mem_lookup
  • vm_mem_pool_alloc
  • vm_mem_stat
  • vm_open
  • vm_part_pstat
  • vm_part_set_mode
  • vm_part_stat
  • vm_proc_mem_iterate
  • vm_procinfo
  • vm_prop_dev_grant
  • vm_prop_int_grant
  • vm_prop_ioport_map
  • vm_prop_mem_map
  • vm_prop_read
  • vm_prop_write
  • vm_qport_control
  • vm_qport_iterate
  • vm_qport_mask
  • vm_qport_open
  • vm_qport_pstat
  • vm_qport_read
  • vm_qport_read_or_mask
  • vm_qport_select
  • vm_qport_stat
  • vm_qport_write
  • vm_qport_write_or_mask
  • vm_read
  • vm_read_at
  • vm_reboot
  • vm_register
  • vm_se_add_romimage
  • vm_se_crit_enter
  • vm_se_crit_leave
  • vm_se_fp_notify
  • vm_se_fp_queue_init
  • vm_se_fp_unit_init
  • vm_se_monitor_hook
  • vm_se_pp_config_data
  • vm_se_pp_iterate
  • vm_se_pp_qp_notify
  • vm_se_thread_create
  • vm_se_thread_start
  • vm_se_thread_stop
  • vm_set_time_sched_scheme
  • vm_shutdown
  • vm_sport_control
  • vm_sport_iterate
  • vm_sport_open
  • vm_sport_pstat
  • vm_sport_read
  • vm_sport_stat
  • vm_sport_write
  • vm_stat
  • vm_target_reset
  • vm_vmem_alloc
  • vm_write
  • vm_write_at

Data types

  • struct vm_file_desc_ext_str
  • struct vm_file_desc_int_str
  • struct vm_file_stat_str
  • struct vm_fp_listen_str
  • struct vm_fp_msg_str
  • struct vm_mem_stat_str
  • struct vm_partition_stat_str
  • struct vm_port_desc_str
  • struct vm_proc_memseg_str
  • struct vm_procinfo_str
  • struct vm_qport_bitmap_str
  • struct vm_qport_stat_str
  • struct vm_se_fp_if_str
  • struct vm_se_fp_statics_str
  • struct vm_se_if_str
  • struct vm_se_pp_if_str
  • struct vm_se_pp_portdesc_str
  • struct vm_se_pp_portdesc_str::queuing_sampling_union::queuing_str
  • struct vm_se_pp_portdesc_str::queuing_sampling_union::sampling_str
  • struct vm_sport_stat_str
  • union vm_file_desc_u
  • union vm_se_pp_portdesc_str::queuing_sampling_union

Definitions

  • VM_BOOLEAN_TYPE
  • VM_FILE_PRIVATE_DATA_SIZE
  • VM_FP_DELIM
  • VM_INTEGER32_TYPE
  • VM_INTEGER64_TYPE
  • VM_IOC (cmd_id)
  • VM_IOC_CMD (cmd_id)
  • VM_IOC_GET_CMD (cmd)
  • VM_IOC_GET_PARAM_IN (cmd)
  • VM_IOC_GET_PARAM_OUT (cmd)
  • VM_IOC_IN (cmd_id, type)
  • VM_IOC_INOUT (cmd_id, itype, otype)
  • VM_IOC_MAX_PARAM_SIZE
  • VM_IOC_OUT (cmd_id, type)
  • VM_IOC_PARAM_IN (n)
  • VM_IOC_PARAM_OUT (n)
  • VM_IOCT_DEF_CMD (name, data)
  • VM_MAX_NUM_FILE_PROVIDER
  • VM_MAX_PARTITION_CNT
  • VM_MAX_PATHNAME_LEN
  • VM_MEM_TYPE_IO_MEM
  • VM_MEM_TYPE_IO_PORT
  • VM_MEM_TYPE_KMEM
  • VM_MEM_TYPE_KMEM
  • VM_MEM_TYPE_RAM
  • VM_MEM_TYPE_ROM
  • VM_MIN_STACKSIZE
  • VM_NAME_LEN
  • VM_NAME_TYPE
  • VM_PATH_DELIM
  • VM_PATH_NAME_TYPE
  • VM_PSSW_XFER_SIZE
  • VM_RFS_VERSION_DELIM
  • VM_SEEK_CUR
  • VM_SEEK_END
  • VM_SEEK_SET
  • VM_STRING_TYPE

It’s not hard to see that file “psswref.pdf” contains references for functions, data types or definitions, which identifier starts from “vm_” or “VM_”.

About Petr Alexeev

Researcher, Department of Information Technologies at Åbo Akademi University, Turku, Finland
This entry was posted in PikeOS. Bookmark the permalink.

One Response to PikeOS API reference in psswref.pdf

  1. Pingback: PikeOS kernel API reference kernelref.pdf | Åbo Academi University Post-DOC Researcher Petr Alexeev

Leave a Reply