syscall.h 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426
  1. /* Syscall interface (int 0x80), shared by the kernel and ring-3 commands. */
  2. #ifndef SYSCALL_H
  3. #define SYSCALL_H
  4. #define SYS_PUTSTR 1
  5. #define SYS_GET_TICKS_MS 2
  6. #define SYS_SLEEP_MS 3
  7. #define SYS_EXIT 4
  8. /* File service (see sys_fs.c). Paths are absolute VFS paths; buffers live in
  9. * the calling process's address space (the kernel runs on its CR3, so no copy
  10. * in/out is needed). */
  11. #define SYS_READ_FILE 5 /* (const char *path, void *buf, unsigned int max)
  12. -> bytes read, or <0 (SYS_E*) */
  13. #define SYS_WRITE_FILE 6 /* (const char *path, const void *buf, unsigned int len)
  14. -> 0, or <0 */
  15. #define SYS_LIST_DIR 7 /* (const char *path, unsigned int index,
  16. struct sys_dirent *out) -> 1 entry, 0 end, <0 */
  17. #define SYS_UNLINK 8 /* (const char *path) -> 0, or <0 */
  18. #define SYS_MKDIR 9 /* (const char *path) -> 0, or <0 */
  19. #define SYS_RMDIR 10 /* (const char *path) -> 0, or <0 */
  20. #define SYS_LIST_MOUNTS 11 /* (unsigned int index, struct sys_mount *out)
  21. -> 1 mount, 0 end */
  22. /* Kernel-state info for the info commands (see sys_info.c). */
  23. #define SYS_MEMINFO 12 /* (struct sys_meminfo *out) -> 0 */
  24. #define SYS_E820 13 /* (unsigned int index, struct sys_e820 *out)-> 1, 0 */
  25. #define SYS_MOUSEINFO 14 /* (struct sys_mouseinfo *out) -> 1 when present */
  26. #define SYS_STORAGE_INFO 15 /* (struct sys_storage_info *out) -> 0;
  27. refreshes the mount cache like `storage` did */
  28. #define SYS_BLKDEV 16 /* (unsigned int index, struct sys_blkdev *out) */
  29. /* Network service (see sys_net.c): the stack and NIC drivers stay in the
  30. * kernel; user commands get the configuration, the DNS/DHCP clients and the
  31. * raw frame paths (so the packet-level commands port unchanged). */
  32. #define SYS_NET_INFO 17 /* (struct sys_netinfo *out) -> 1 = NIC present */
  33. #define SYS_NET_PRINT_INFO 18 /* the driver's status lines */
  34. #define SYS_NET_ACQUIRE 19 /* take the receiver for this process (0/-1) */
  35. #define SYS_NET_RELEASE 20
  36. #define SYS_NET_MAC 21 /* (unsigned char mac[6]) -> 0/-1 */
  37. #define SYS_NET_GET_IP 22 /* (unsigned char ip[4]) */
  38. #define SYS_NET_SET_IP 23 /* (const unsigned char ip[4]) */
  39. #define SYS_NET_GET_MASK 24
  40. #define SYS_NET_GET_GW 25
  41. #define SYS_NET_GET_DNS 26
  42. #define SYS_NET_SET_DNS 27
  43. #define SYS_NET_TX 28 /* (const void *buf, unsigned len) -> 0/-1 */
  44. #define SYS_NET_RX 29 /* (void *buf, unsigned max) -> len/-1 */
  45. #define SYS_NET_DECODE 30 /* (const void *buf, unsigned len): one line */
  46. #define SYS_NET_REPLY 31 /* (in, len, out, max) -> reply length / 0 */
  47. #define SYS_NET_LOOPBACK 32 /* (int on) -> 0/-1 */
  48. #define SYS_NET_REGS 33 /* the driver's register dump */
  49. #define SYS_NET_RESET 34 /* driver re-init */
  50. #define SYS_DHCP_RUN 35 /* (timeout_ms) -> dhcp_run() result */
  51. #define SYS_DHCP_INFO 36 /* (unsigned char ip[4], unsigned *lease) -> 1 */
  52. #define SYS_DNS_RESOLVE 37 /* (name, unsigned char ip[4]) -> 0; caller owns */
  53. #define SYS_NETLOG 38 /* (const char *text) -> 0/-1 */
  54. #define SYS_NETLOG_CONF 39 /* (int enabled_or_-1, const ip[4] or NULL) */
  55. /* TCP client (see sys_net.c/tcp.c): one connection at a time; the caller
  56. * must own the NIC (SYS_NET_ACQUIRE). */
  57. #define SYS_TCP_CONNECT 40 /* (mac[6], ip[4], port) -> 0/-1/-2/-3 */
  58. #define SYS_TCP_PEER_MSS 41 /* () -> the peer's MSS of the current conn */
  59. #define SYS_TCP_SEND 42 /* (buf, len) -> 0/-1/-2/-3 */
  60. #define SYS_TCP_RECV 43 /* (buf, max, timeout_ms) -> >0/0/-1/-2 */
  61. #define SYS_TCP_CLOSE 44 /* () */
  62. #define SYS_NET_NEXT_HOP 45 /* (dst[4], hop[4]) */
  63. #define SYS_NET_ARP 46 /* (ip[4], mac[6]) -> 0/-1/-2 (net_arp_resolve) */
  64. #define SYS_NET_CONFIGURED 47 /* () -> 1 when an IP address is set */
  65. #define SYS_GETCWD 48 /* (char *buf, unsigned max) -> 0; the caller's cwd */
  66. /* Process snapshot for the `top` command (see process.c). */
  67. #define SYS_PROCINFO 49 /* (unsigned int index, struct sys_procinfo *out)
  68. -> 1 when found, 0 at the end of the table */
  69. #define SYS_KEY_POLL 55 /* () -> 0 none, ASCII, or IO_KEY_* for the caller's window */
  70. #define SYS_RTC_HMS 56 /* (struct sys_time *out) -> 0/-1 */
  71. #define SYS_RTC_GET 104 /* (struct sys_datetime *out) -> 0/-1 */
  72. #define SYS_RTC_SET 105 /* (const struct sys_datetime *in) -> 0/-1 */
  73. #define SYS_NTP_SYNC 106 /* (const char *server, unsigned timeout_ms,
  74. struct sys_datetime *out) -> SYS_NTP_*;
  75. the service owns the NIC for the duration */
  76. /* SYS_NTP_SYNC results. */
  77. #define SYS_NTP_OK 0
  78. #define SYS_NTP_ENONIC (-1) /* no NIC */
  79. #define SYS_NTP_ENAME (-2) /* server name could not be resolved */
  80. #define SYS_NTP_EARP (-3) /* no ARP reply for the next hop */
  81. #define SYS_NTP_ETX (-4) /* NIC transmit failed */
  82. #define SYS_NTP_ETIMEOUT (-5) /* no NTP reply */
  83. #define SYS_NTP_EREPLY (-6) /* malformed, unsynchronised or KoD reply */
  84. #define SYS_NTP_EBUSY (-7) /* another process owns the receiver */
  85. /* Window-manager service (see wm_abi.h). Only the kernel-spawned WM process
  86. * may call the WM_* entries; ordinary commands get -1. */
  87. #define SYS_WM_ATTACH 57 /* (struct wm_screen_info *out) -> 0/-1 */
  88. #define SYS_WM_INFO 58 /* (index, struct wm_window_info *out) -> 1/0/-1 */
  89. #define SYS_WM_MAP 59 /* (index, struct wm_map_info *out) -> 0/-1 */
  90. #define SYS_WM_ACK 60 /* (index, dirty_seq) -> 0/-1 */
  91. #define SYS_WM_FOCUS 61 /* (index) -> 0/-1 */
  92. #define SYS_WM_SET_GEOM 62 /* (index, struct wm_geom *in) -> 0/-1 */
  93. #define SYS_WM_CREATE_TERM 63 /* () -> index / -1 */
  94. #define SYS_WM_CLOSE 64 /* (index) -> 0/-1 */
  95. #define SYS_WM_POLL 65 /* (struct wm_status *out) -> 0/-1 */
  96. #define SYS_WM_BEGIN 66 /* () -> 0/-1; erase cursor, frame active */
  97. #define SYS_WM_PRESENT 67 /* (struct wm_present_info *in) -> 0/-1 */
  98. #define SYS_WM_SYNC 68 /* () -> 0/-1; run deferred gfx cleanup */
  99. #define SYS_RTC_DATETIME 69 /* (char *buf, unsigned max) -> 0/-1 */
  100. #define SYS_WIN_CREATE 70 /* (struct win_create *in, struct win_info *out) */
  101. #define SYS_WIN_PRESENT 71 /* (const struct wm_win_present *in) -> 0/-1;
  102. NULL or w/h 0 publishes the whole canvas */
  103. #define SYS_WIN_CLOSE 72 /* () -> 0/-1; close the caller's window */
  104. #define SYS_WM_RESIZE 83 /* (index, struct wm_size *content) -> 0/-1 */
  105. #define SYS_WIN_INFO 84 /* (struct win_info *out) -> 0/-1 */
  106. #define SYS_WIN_ACK_RESIZE 85 /* () -> 0/-1; swap in the pending canvas */
  107. #define SYS_WIN_POINTER 86 /* (struct win_pointer *out) -> 0/-1 */
  108. #define SYS_WIN_EVENT 87 /* (struct win_event *out) -> 1 event, 0 none */
  109. #define SYS_WIN_SCROLL 109 /* (struct win_scroll *out) -> 1 delta, 0 none, -1 */
  110. /* Per-process anonymous heap (see sys_mem.c). One growable arena at
  111. * USER_HEAP_BASE (0x60000000), at most USER_HEAP_MAX (32 MB), freed when the
  112. * process exits. SYS_MEM_ALLOC returns the base address, or <0. Ring-3
  113. * commands use malloc/free (libc/malloc.c); these syscalls are the libc
  114. * backend (libc/ucmd_mem.c) and are not called by application code. */
  115. #define SYS_MEM_ALLOC 88 /* (unsigned bytes) -> VA or <0 */
  116. #define SYS_MEM_GROW 89 /* (unsigned total_bytes) -> 0/-1; new pages not zeroed */
  117. #define SYS_MEM_FREE 90 /* () -> 0/-1 */
  118. /* CPU temperature (see thermal.c): the hottest core's DTS reading. */
  119. #define SYS_CPU_TEMP 91 /* (struct sys_cputemp *out) -> 0/-1 */
  120. /* IT87xx Super I/O hardware monitor (see it87.c); read-only. */
  121. #define SYS_SENSORS 92 /* (struct sys_sensors *out) -> 0/-1 */
  122. /* TCP server (WebDAV listener). The caller must own the NIC (SYS_NET_ACQUIRE).
  123. * SYS_TCP_ACCEPT polls a few frames and returns 1 once a connection is ready,
  124. * 0 when nothing arrived, or -3 when a netkexec header was captured (the
  125. * command should exit and let the kworker take over). */
  126. #define SYS_TCP_LISTEN 93 /* (port) -> 0/-1 */
  127. #define SYS_TCP_ACCEPT 94 /* () -> 1/0/-2/-3 */
  128. #define SYS_TCP_SRV_RECV 95 /* (buf, max, timeout_ms) -> >0/0/-1/-2 */
  129. #define SYS_TCP_SRV_SEND 96 /* (buf, len) -> 0/-1/-2/-3 */
  130. #define SYS_TCP_SRV_CLOSE 97
  131. #define SYS_TCP_PEER 99 /* (ip[4], unsigned *port) -> 0/-1 (debug log) */
  132. #define SYS_NET_SPEED 100 /* (mbps) -> 0; 0 = auto, 100 = force 100M */
  133. #define SYS_NET_MAC_SET 101 /* (const mac[6]) -> 0/-1/-2 */
  134. /* ThinkPad embedded-controller sensors (see tpec.c); read-only. */
  135. #define SYS_TPEC_SENSORS 102 /* (struct sys_tpec_sensors *out) -> 0/-1 */
  136. /* AC/battery snapshot from the board EC (see power_src.c, tpec.c and
  137. * cros_ec.c). SYS_POWER_F_DETAIL also reads design capacity, the capacity
  138. * unit and the manufacturer/model/serial strings. */
  139. #define SYS_POWER_INFO 103 /* (struct sys_powerinfo *out, flags) -> 0/-1 */
  140. #define SYS_POWER_F_DETAIL 0x1
  141. #define SYS_POWER_SRC_NONE 0
  142. #define SYS_POWER_SRC_TPEC 1 /* ThinkPad H8 EC */
  143. #define SYS_POWER_SRC_CROS 2 /* Chrome OS EC */
  144. /* Chrome OS EC temperature/fan/switch snapshot (see cros_ec.c). */
  145. #define SYS_CROS_EC_SENSORS 107 /* (struct sys_cros_sensors *out) -> 0/-1 */
  146. /* Current process id (used for per-process temporary paths). */
  147. #define SYS_GETPID 108 /* () -> pid */
  148. /* Stat one path (the file service has no open handle). */
  149. #define SYS_FS_STAT 98 /* (path, struct sys_stat *out) -> 0/<0 */
  150. /* Terminal / process services used by the ring-3 shell. */
  151. #define SYS_TTY_CREATE 73 /* () -> tty id 1..TTY_MAX / -1 */
  152. #define SYS_TTY_READ 74 /* (id, buf, max) -> bytes / 0 / -1 */
  153. #define SYS_SPAWN 75 /* (path, arg, tty, cwd) -> pid / <0 */
  154. #define SYS_SPAWN_KCMD 76 /* (name, arg, tty) -> pid / <0 */
  155. #define SYS_ALIVE 77 /* (pid) -> 1/0 */
  156. #define SYS_KILL 78 /* (pid) -> 0/-1 */
  157. #define SYS_CHDIR 79 /* (path) -> 0/-1 */
  158. #define SYS_WIN_KEY_WAIT 80 /* (timeout_ms) -> key / 0 timeout / -1 */
  159. #define SYS_SCHEDINFO 81 /* (struct sys_schedinfo *out) -> 0/-1 */
  160. struct sys_spawn {
  161. const char *path;
  162. const char *arg;
  163. const char *cwd;
  164. unsigned int tty;
  165. };
  166. struct sys_netinfo {
  167. unsigned int present;
  168. unsigned char mac[6];
  169. unsigned char ip[4];
  170. unsigned char mask[4];
  171. unsigned char gw[4];
  172. unsigned char dns[4];
  173. unsigned int mirror_on;
  174. unsigned char mirror_host[4];
  175. char name[8];
  176. char chip[16];
  177. };
  178. /* Error codes returned by the file syscalls. */
  179. #define SYS_EIO (-1) /* disk I/O error */
  180. #define SYS_ENODEV (-2) /* no such device / unusable path prefix */
  181. #define SYS_ENOFS (-3) /* device exists but has no mounted filesystem */
  182. #define SYS_ENOENT (-4) /* file/directory not found */
  183. #define SYS_EINVAL (-5) /* path is not valid for this operation */
  184. #define SYS_EWRITE (-6) /* write refused (full, or FAT rejected it) */
  185. #define SYS_EROFS (-7) /* read-only filesystem (ramfs) */
  186. #define SYS_ENOSPC (-8) /* no space left on the filesystem */
  187. /* One directory entry. `name` is a display name: raw 8.3 for FAT mounts
  188. * (space padded, `raw_83` set) or the plain name for name-string filesystems
  189. * such as ramfs and /share. */
  190. struct sys_dirent {
  191. char name[64];
  192. unsigned int size;
  193. unsigned int is_dir;
  194. unsigned int raw_83;
  195. };
  196. /* One mounted filesystem (for `ls /`). */
  197. struct sys_mount {
  198. char name[16];
  199. char type[8]; /* "FAT12", "FAT16", "FAT32", "ramfs", "share" */
  200. unsigned int total_sectors;
  201. char label[12];
  202. unsigned int ro;
  203. };
  204. /* Result of SYS_FS_STAT. */
  205. struct sys_stat {
  206. unsigned int size;
  207. unsigned int is_dir;
  208. unsigned int ro;
  209. };
  210. struct sys_meminfo {
  211. unsigned int total_kb;
  212. unsigned int free_pages;
  213. unsigned int page_size;
  214. unsigned int e820_count;
  215. };
  216. /* One live process, for `top` (PROC_NAME_LEN = 12). cpu_ticks/life_ticks
  217. * are PIT ticks (1 kHz), so lifecycle percentages can be derived. */
  218. struct sys_procinfo {
  219. unsigned int pid;
  220. unsigned int state; /* PROC_*: 1 ready, 2 running, 4 sleep, 5 block */
  221. unsigned int cpu_ticks; /* ticks spent as the running process */
  222. unsigned int life_ticks; /* ticks since creation, >= 1 */
  223. unsigned int pages; /* resident 4 KB pages (stack + dir + user) */
  224. unsigned int weight; /* CFS weight, 1..SCHED_WEIGHT_MAX */
  225. unsigned int cpu; /* CPU id, or 0xFFFFFFFF when not running */
  226. char name[12];
  227. };
  228. /* Scheduler counters for `top` and the `sched` command. */
  229. struct sys_schedinfo {
  230. unsigned int ncpus;
  231. unsigned int runnable;
  232. unsigned int sleeping;
  233. unsigned int blocked;
  234. unsigned int zombies;
  235. unsigned int switches;
  236. unsigned int wakeups;
  237. unsigned int idle_ticks;
  238. unsigned int slice_ticks;
  239. };
  240. /* CPU temperature snapshot (see thermal.c). temp_c is the hottest core's
  241. * last DTS sample; a negative value means no Intel DTS is available. delta_c
  242. * and status are from the CPU that serviced the syscall (for diagnostics).
  243. * cpu_temp_c[] holds the per-logical-CPU cached samples. */
  244. #define SYS_CPU_MAX 8
  245. struct sys_cputemp {
  246. int temp_c;
  247. int tjmax_c;
  248. int delta_c;
  249. unsigned int status;
  250. int cpu_temp_c[SYS_CPU_MAX];
  251. unsigned int ncpus;
  252. };
  253. /* IT87xx hardware monitor snapshot (temps are signed; -128 = unconnected). */
  254. struct sys_sensors {
  255. unsigned int present;
  256. unsigned int chip_id;
  257. unsigned int base;
  258. unsigned int temp_enable;
  259. unsigned int temp_extra;
  260. int temp_c[3];
  261. unsigned int fan_rpm[3];
  262. };
  263. /* ThinkPad embedded-controller snapshot (see tpec.c). temp_c[] follows
  264. * thinkpad_acpi's temp1..temp16 (EC 0x78..0x7F, then 0xC0..0xC7); -128 means
  265. * the sensor is not present. fan_level is the raw EC 0x2F value. */
  266. #define SYS_TPEC_TEMP_MAX 16
  267. struct sys_tpec_sensors {
  268. unsigned int present;
  269. char vendor[16];
  270. char product[32];
  271. char version[32];
  272. int temp_c[SYS_TPEC_TEMP_MAX];
  273. unsigned int fan_rpm;
  274. unsigned int fan_level;
  275. };
  276. /* AC/battery snapshot. rate is the signed present rate in the same unit as
  277. * the capacities; unit_mwh (when unit_known) selects mWh/mW vs mAh/mA.
  278. * percent is valid only when percent_valid is set. cycle_count/serial are
  279. * zero/empty when the backend does not provide them. */
  280. #define SYS_POWER_BATT_MAX 2
  281. struct sys_battery {
  282. unsigned int present;
  283. unsigned int error;
  284. unsigned int status; /* raw EC status/flags byte */
  285. unsigned int charging;
  286. unsigned int discharging;
  287. unsigned int percent;
  288. unsigned int percent_valid;
  289. unsigned int remaining;
  290. unsigned int full;
  291. unsigned int design;
  292. unsigned int voltage_mv;
  293. int rate;
  294. unsigned int unit_known;
  295. unsigned int unit_mwh;
  296. char manufacturer[16];
  297. char model[16];
  298. unsigned int cycle_count;
  299. char serial[16];
  300. };
  301. struct sys_powerinfo {
  302. unsigned int present; /* a supported EC was found */
  303. unsigned int source; /* SYS_POWER_SRC_* */
  304. int ac_online; /* -1 unknown, 0 offline, 1 online */
  305. unsigned int ec_rev;
  306. char vendor[16];
  307. char product[32];
  308. char version[32];
  309. unsigned int battery_count;
  310. struct sys_battery battery[SYS_POWER_BATT_MAX];
  311. };
  312. /* Chrome OS EC board sensors (see cros_ec.c). temp_c[] is -128 when the
  313. * sensor is absent/unavailable; fan_present is a bitmask over fan_rpm[].
  314. * switches follows EC_MEMMAP_SWITCHES (bit 0 lid open, bit 1 power button). */
  315. #define SYS_CROS_TEMP_MAX 24
  316. #define SYS_CROS_FAN_MAX 4
  317. struct sys_cros_sensors {
  318. unsigned int present;
  319. unsigned int acpi_version;
  320. unsigned int battery_version;
  321. unsigned int thermal_version;
  322. int temp_c[SYS_CROS_TEMP_MAX];
  323. unsigned int fan_rpm[SYS_CROS_FAN_MAX];
  324. unsigned int fan_present;
  325. unsigned int fan_duty; /* 0xff = automatic */
  326. unsigned int switches;
  327. };
  328. /* Wall clock for the ring-3 clock (see rtc.c). */
  329. struct sys_time {
  330. unsigned int hour; /* 0-23 */
  331. unsigned int minute; /* 0-59 */
  332. unsigned int second; /* 0-59 */
  333. };
  334. /* Full RTC wall clock for `date` and the Date & Time app. The CMOS RTC
  335. * stores a two-digit year; the kernel expands it with a 1970-2069 window
  336. * (70-99 -> 1900s, 00-69 -> 2000s), so a dead-battery default such as 1980
  337. * or 1990 reads correctly. SYS_RTC_SET accepts the same range. */
  338. struct sys_datetime {
  339. unsigned int year; /* 1970-2069 */
  340. unsigned int month; /* 1-12 */
  341. unsigned int day; /* 1-31 */
  342. unsigned int hour; /* 0-23 */
  343. unsigned int minute; /* 0-59 */
  344. unsigned int second; /* 0-59 */
  345. unsigned int wday; /* 0 = Sunday */
  346. };
  347. struct sys_e820 {
  348. unsigned int base; /* low 32 bits, as meminfo always printed */
  349. unsigned int length;
  350. unsigned int type;
  351. };
  352. struct sys_mouseinfo {
  353. unsigned int present;
  354. unsigned int ps2;
  355. unsigned int ps2_id;
  356. unsigned int ps2_packet_size;
  357. unsigned int ps2_streaming;
  358. unsigned int usb;
  359. unsigned int usb_ctrl;
  360. unsigned int usb_addr;
  361. unsigned int usb_ep;
  362. unsigned int usb_mps;
  363. unsigned int usb_low;
  364. unsigned int usb_keyboard;
  365. unsigned int cursor_visible;
  366. char hcd[8];
  367. char backend[16];
  368. unsigned int touchpad;
  369. unsigned int tp_vendor;
  370. unsigned int tp_product;
  371. };
  372. struct sys_storage_info {
  373. unsigned int ahci_present;
  374. unsigned int blkdev_count;
  375. };
  376. struct sys_blkdev {
  377. char name[8];
  378. char model[41];
  379. unsigned int kind; /* 0 = floppy, 1 = IDE, 2 = SATA, 3 = MMC, 4 = USB */
  380. unsigned int present;
  381. unsigned int total_sectors;
  382. };
  383. int syscall_dispatch(int num, int a1, int a2, int a3);
  384. #endif