home *** CD-ROM | disk | FTP | other *** search
/ PC Extra Super CD 1998 January / PCPLUS131.iso / DJGPP / V2 / DJDEV201.ZIP / include / dpmi.h < prev    next >
Encoding:
C/C++ Source or Header  |  1995-12-23  |  16.1 KB  |  349 lines
  1. /* Copyright (C) 1995 DJ Delorie, see COPYING.DJ for details */
  2. #ifndef __dj_include_dpmi_h_
  3. #define __dj_include_dpmi_h_
  4.  
  5. #ifdef __cplusplus
  6. extern "C" {
  7. #endif
  8.  
  9. #ifndef __dj_ENFORCE_ANSI_FREESTANDING
  10.  
  11. #ifndef __STRICT_ANSI__
  12.  
  13. #ifndef _POSIX_SOURCE
  14.  
  15. extern unsigned short __dpmi_error;
  16.  
  17. typedef struct {
  18.   unsigned short offset16;
  19.   unsigned short segment;
  20. } __dpmi_raddr;
  21.  
  22. typedef struct {
  23.   unsigned long  offset32;
  24.   unsigned short selector;
  25. } __dpmi_paddr;
  26.  
  27. typedef struct {
  28.   unsigned long handle;            /* 0, 2 */
  29.   unsigned long size;     /* or count */    /* 4, 6 */
  30.   unsigned long address;        /* 8, 10 */
  31. } __dpmi_meminfo;
  32.  
  33. typedef union {
  34.   struct {
  35.     unsigned long edi;
  36.     unsigned long esi;
  37.     unsigned long ebp;
  38.     unsigned long res;
  39.     unsigned long ebx;
  40.     unsigned long edx;
  41.     unsigned long ecx;
  42.     unsigned long eax;
  43.   } d;
  44.   struct {
  45.     unsigned short di, di_hi;
  46.     unsigned short si, si_hi;
  47.     unsigned short bp, bp_hi;
  48.     unsigned short res, res_hi;
  49.     unsigned short bx, bx_hi;
  50.     unsigned short dx, dx_hi;
  51.     unsigned short cx, cx_hi;
  52.     unsigned short ax, ax_hi;
  53.     unsigned short flags;
  54.     unsigned short es;
  55.     unsigned short ds;
  56.     unsigned short fs;
  57.     unsigned short gs;
  58.     unsigned short ip;
  59.     unsigned short cs;
  60.     unsigned short sp;
  61.     unsigned short ss;
  62.   } x;
  63.   struct {
  64.     unsigned char edi[4];
  65.     unsigned char esi[4];
  66.     unsigned char ebp[4];
  67.     unsigned char res[4];
  68.     unsigned char bl, bh, ebx_b2, ebx_b3;
  69.     unsigned char dl, dh, edx_b2, edx_b3;
  70.     unsigned char cl, ch, ecx_b2, ecx_b3;
  71.     unsigned char al, ah, eax_b2, eax_b3;
  72.   } h;
  73. } __dpmi_regs;
  74.   
  75. typedef struct {
  76.   unsigned char  major;
  77.   unsigned char  minor;
  78.   unsigned short flags;
  79.   unsigned char  cpu;
  80.   unsigned char  master_pic;
  81.   unsigned char  slave_pic;
  82. } __dpmi_version_ret;
  83.  
  84. typedef struct {
  85.   unsigned long largest_available_free_block_in_bytes;
  86.   unsigned long maximum_unlocked_page_allocation_in_pages;
  87.   unsigned long maximum_locked_page_allocation_in_pages;
  88.   unsigned long linear_address_space_size_in_pages;
  89.   unsigned long total_number_of_unlocked_pages;
  90.   unsigned long total_number_of_free_pages;
  91.   unsigned long total_number_of_physical_pages;
  92.   unsigned long free_linear_address_space_in_pages;
  93.   unsigned long size_of_paging_file_partition_in_pages;
  94.   unsigned long reserved[3];
  95. } __dpmi_free_mem_info;
  96.  
  97. typedef struct {
  98.   unsigned long total_allocated_bytes_of_physical_memory_host;
  99.   unsigned long total_allocated_bytes_of_virtual_memory_host;
  100.   unsigned long total_available_bytes_of_virtual_memory_host;
  101.   unsigned long total_allocated_bytes_of_virtual_memory_vcpu;
  102.   unsigned long total_available_bytes_of_virtual_memory_vcpu;
  103.   unsigned long total_allocated_bytes_of_virtual_memory_client;
  104.   unsigned long total_available_bytes_of_virtual_memory_client;
  105.   unsigned long total_locked_bytes_of_memory_client;
  106.   unsigned long max_locked_bytes_of_memory_client;
  107.   unsigned long highest_linear_address_available_to_client;
  108.   unsigned long size_in_bytes_of_largest_free_memory_block;
  109.   unsigned long size_of_minimum_allocation_unit_in_bytes;
  110.   unsigned long size_of_allocation_alignment_unit_in_bytes;
  111.   unsigned long reserved[19];
  112. } __dpmi_memory_info;
  113.  
  114. typedef struct {
  115.   unsigned long data16[2];
  116.   unsigned long code16[2];
  117.   unsigned short ip;
  118.   unsigned short reserved;
  119.   unsigned long data32[2];
  120.   unsigned long code32[2];
  121.   unsigned long eip;
  122. } __dpmi_callback_info;
  123.  
  124. typedef struct {
  125.   unsigned long size_requested;
  126.   unsigned long size;
  127.   unsigned long handle;
  128.   unsigned long address;
  129.   unsigned long name_offset;
  130.   unsigned short name_selector;
  131.   unsigned short reserved1;
  132.   unsigned long reserved2;
  133. } __dpmi_shminfo;
  134.  
  135. /* Unless otherwise noted, all functions return -1 on error, setting __dpmi_error to the DPMI error code */
  136.  
  137. void    __dpmi_yield(void);                                    /* INT 0x2F AX=1680 */
  138.  
  139. int    __dpmi_allocate_ldt_descriptors(int _count);                        /* DPMI 0.9 AX=0000 */
  140. int    __dpmi_free_ldt_descriptor(int _descriptor);                        /* DPMI 0.9 AX=0001 */
  141. int    __dpmi_segment_to_descriptor(int _segment);                        /* DPMI 0.9 AX=0002 */
  142. int    __dpmi_get_selector_increment_value(void);                        /* DPMI 0.9 AX=0003 */
  143. int    __dpmi_get_segment_base_address(int _selector, unsigned long *_addr);            /* DPMI 0.9 AX=0006 */
  144. int    __dpmi_set_segment_base_address(int _selector, unsigned long _address);            /* DPMI 0.9 AX=0007 */
  145. unsigned long __dpmi_get_segment_limit(int _selector);                        /* LSL instruction  */
  146. int    __dpmi_set_segment_limit(int _selector, unsigned long _limit);                /* DPMI 0.9 AX=0008 */
  147. int    __dpmi_get_descriptor_access_rights(int _selector);                    /* LAR instruction  */
  148. int    __dpmi_set_descriptor_access_rights(int _selector, int _rights);            /* DPMI 0.9 AX=0009 */
  149. int    __dpmi_create_alias_descriptor(int _selector);                        /* DPMI 0.9 AX=000a */
  150. int    __dpmi_get_descriptor(int _selector, void *_buffer);                    /* DPMI 0.9 AX=000b */
  151. int    __dpmi_set_descriptor(int _selector, void *_buffer);                    /* DPMI 0.9 AX=000c */
  152. int    __dpmi_allocate_specific_ldt_descriptor(int _selector);                    /* DPMI 0.9 AX=000d */
  153.  
  154. int    __dpmi_get_multiple_descriptors(int _count, void *_buffer);                /* DPMI 1.0 AX=000e */
  155. int    __dpmi_set_multiple_descriptors(int _count, void *_buffer);                /* DPMI 1.0 AX=000f */
  156.  
  157. int    __dpmi_allocate_dos_memory(int _paragraphs, int *_ret_selector_or_max);            /* DPMI 0.9 AX=0100 */
  158. int    __dpmi_free_dos_memory(int _selector);                            /* DPMI 0.9 AX=0101 */
  159. int    __dpmi_resize_dos_memory(int _selector, int _newpara, int *_ret_max);            /* DPMI 0.9 AX=0102 */
  160.  
  161. int    __dpmi_get_real_mode_interrupt_vector(int _vector, __dpmi_raddr *_address);        /* DPMI 0.9 AX=0200 */
  162. int    __dpmi_set_real_mode_interrupt_vector(int _vector, __dpmi_raddr *_address);        /* DPMI 0.9 AX=0201 */
  163. int    __dpmi_get_processor_exception_handler_vector(int _vector, __dpmi_paddr *_address);    /* DPMI 0.9 AX=0202 */
  164. int    __dpmi_set_processor_exception_handler_vector(int _vector, __dpmi_paddr *_address);    /* DPMI 0.9 AX=0203 */
  165. int    __dpmi_get_protected_mode_interrupt_vector(int _vector, __dpmi_paddr *_address);    /* DPMI 0.9 AX=0204 */
  166. int    __dpmi_set_protected_mode_interrupt_vector(int _vector, __dpmi_paddr *_address);    /* DPMI 0.9 AX=0205 */
  167.  
  168. int    __dpmi_get_extended_exception_handler_vector_pm(int _vector, __dpmi_paddr *_address);    /* DPMI 1.0 AX=0210 */
  169. int    __dpmi_get_extended_exception_handler_vector_rm(int _vector, __dpmi_paddr *_address);    /* DPMI 1.0 AX=0211 */
  170. int    __dpmi_set_extended_exception_handler_vector_pm(int _vector, __dpmi_paddr *_address);    /* DPMI 1.0 AX=0212 */
  171. int    __dpmi_set_extended_exception_handler_vector_rm(int _vector, __dpmi_paddr *_address);    /* DPMI 1.0 AX=0213 */
  172.  
  173. int    __dpmi_simulate_real_mode_interrupt(int _vector, __dpmi_regs *_regs);            /* DPMI 0.9 AX=0300 */
  174. int    __dpmi_int(int _vector, __dpmi_regs *_regs); /* like above, but sets ss sp fl */    /* DPMI 0.9 AX=0300 */
  175. extern short __dpmi_int_ss, __dpmi_int_sp, __dpmi_int_flags; /* default to zero */
  176. int    __dpmi_simulate_real_mode_procedure_retf(__dpmi_regs *_regs);                /* DPMI 0.9 AX=0301 */
  177. int    __dpmi_simulate_real_mode_procedure_retf_stack(__dpmi_regs *_regs, int stack_bytes_to_copy, const void *stack_bytes); /* DPMI 0.9 AX=0301 */
  178. int    __dpmi_simulate_real_mode_procedure_iret(__dpmi_regs *_regs);                /* DPMI 0.9 AX=0302 */
  179. int    __dpmi_allocate_real_mode_callback(void (*_handler)(void), __dpmi_regs *_regs, __dpmi_raddr *_ret); /* DPMI 0.9 AX=0303 */
  180. int    __dpmi_free_real_mode_callback(__dpmi_raddr *_addr);                    /* DPMI 0.9 AX=0304 */
  181. int    __dpmi_get_state_save_restore_addr(__dpmi_raddr *_rm, __dpmi_paddr *_pm);        /* DPMI 0.9 AX=0305 */
  182. int    __dpmi_get_raw_mode_switch_addr(__dpmi_raddr *_rm, __dpmi_paddr *_pm);            /* DPMI 0.9 AX=0306 */
  183.  
  184. int    __dpmi_get_version(__dpmi_version_ret *_ret);                        /* DPMI 0.9 AX=0400 */
  185.  
  186. int    __dpmi_get_capabilities(int *_flags, char *vendor_info);                /* DPMI 1.0 AX=0401 */
  187.  
  188. int    __dpmi_get_free_memory_information(__dpmi_free_mem_info *_info);            /* DPMI 0.9 AX=0500 */
  189. int    __dpmi_allocate_memory(__dpmi_meminfo *_info);                        /* DPMI 0.9 AX=0501 */
  190. int    __dpmi_free_memory(unsigned long _handle);                        /* DPMI 0.9 AX=0502 */
  191. int    __dpmi_resize_memory(__dpmi_meminfo *_info);                        /* DPMI 0.9 AX=0503 */
  192.  
  193. int    __dpmi_allocate_linear_memory(__dpmi_meminfo *_info, int _commit);            /* DPMI 1.0 AX=0504 */
  194. int    __dpmi_resize_linear_memory(__dpmi_meminfo *_info, int _commit);            /* DPMI 1.0 AX=0505 */
  195. int    __dpmi_get_page_attributes(__dpmi_meminfo *_info, short *_buffer);            /* DPMI 1.0 AX=0506 */
  196. int    __dpmi_set_page_attributes(__dpmi_meminfo *_info, short *_buffer);            /* DPMI 1.0 AX=0507 */
  197. int    __dpmi_map_device_in_memory_block(__dpmi_meminfo *_info, unsigned long _physaddr);    /* DPMI 1.0 AX=0508 */
  198. int    __dpmi_map_conventional_memory_in_memory_block(__dpmi_meminfo *_info, unsigned long _physaddr); /* DPMI 1.0 AX=0509 */
  199. int    __dpmi_get_memory_block_size_and_base(__dpmi_meminfo *_info);                /* DPMI 1.0 AX=050a */
  200. int    __dpmi_get_memory_information(__dpmi_memory_info *_buffer);                /* DPMI 1.0 AX=050b */
  201.  
  202. int    __dpmi_lock_linear_region(__dpmi_meminfo *_info);                    /* DPMI 0.9 AX=0600 */
  203. int    __dpmi_unlock_linear_region(__dpmi_meminfo *_info);                    /* DPMI 0.9 AX=0601 */
  204. int    __dpmi_mark_real_mode_region_as_pageable(__dpmi_meminfo *_info);            /* DPMI 0.9 AX=0602 */
  205. int    __dpmi_relock_real_mode_region(__dpmi_meminfo *_info);                    /* DPMI 0.9 AX=0603 */
  206. int    __dpmi_get_page_size(unsigned long *_size);                        /* DPMI 0.9 AX=0604 */
  207.  
  208. int    __dpmi_mark_page_as_demand_paging_candidate(__dpmi_meminfo *_info);            /* DPMI 0.9 AX=0702 */
  209. int    __dpmi_discard_page_contents(__dpmi_meminfo *_info);                    /* DPMI 0.9 AX=0703 */
  210.  
  211. int    __dpmi_physical_address_mapping(__dpmi_meminfo *_info);                    /* DPMI 0.9 AX=0800 */
  212. int    __dpmi_free_physical_address_mapping(__dpmi_meminfo *_info);                /* DPMI 0.9 AX=0801 */
  213.  
  214. /* These next four functions return the old state */
  215. int    __dpmi_get_and_disable_virtual_interrupt_state(void);                    /* DPMI 0.9 AX=0900 */
  216. int    __dpmi_get_and_enable_virtual_interrupt_state(void);                    /* DPMI 0.9 AX=0901 */
  217. int    __dpmi_get_and_set_virtual_interrupt_state(int _old_state);                /* DPMI 0.9 AH=09   */
  218. int    __dpmi_get_virtual_interrupt_state(void);                        /* DPMI 0.9 AX=0902 */
  219.  
  220. int    __dpmi_get_vendor_specific_api_entry_point(char *_id, __dpmi_paddr *_api);        /* DPMI 0.9 AX=0a00 */
  221.  
  222. int    __dpmi_set_debug_watchpoint(__dpmi_meminfo *_info, int _type);                /* DPMI 0.9 AX=0b00 */
  223. int    __dpmi_clear_debug_watchpoint(unsigned long _handle);                    /* DPMI 0.9 AX=0b01 */
  224. int    __dpmi_get_state_of_debug_watchpoint(unsigned long _handle, int *_status);        /* DPMI 0.9 AX=0b02 */
  225. int    __dpmi_reset_debug_watchpoint(unsigned long _handle);                    /* DPMI 0.9 AX=0b03 */
  226.  
  227. int    __dpmi_install_resident_service_provider_callback(__dpmi_callback_info *_info);        /* DPMI 1.0 AX=0c00 */
  228. int    __dpmi_terminate_and_stay_resident(int return_code, int paragraphs_to_keep);        /* DPMI 1.0 AX=0c01 */
  229.  
  230. int    __dpmi_allocate_shared_memory(__dpmi_shminfo *_info);                    /* DPMI 1.0 AX=0d00 */
  231. int    __dpmi_free_shared_memory(unsigned long _handle);                    /* DPMI 1.0 AX=0d01 */
  232. int    __dpmi_serialize_on_shared_memory(unsigned long _handle, int _flags);            /* DPMI 1.0 AX=0d02 */
  233. int    __dpmi_free_serialization_on_shared_memory(unsigned long _handle, int _flags);        /* DPMI 1.0 AX=0d03 */
  234.  
  235. int    __dpmi_get_coprocessor_status(void);                            /* DPMI 1.0 AX=0e00 */
  236. int    __dpmi_set_coprocessor_emulation(int _flags);                        /* DPMI 1.0 AX=0e01 */
  237.  
  238. /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
  239. /* Backwards compatibility stuff                               */
  240.  
  241. #define _go32_dpmi_registers            __dpmi_regs
  242.  
  243. typedef struct {
  244.   unsigned long available_memory;
  245.   unsigned long available_pages;
  246.   unsigned long available_lockable_pages;
  247.   unsigned long linear_space;
  248.   unsigned long unlocked_pages;
  249.   unsigned long available_physical_pages;
  250.   unsigned long total_physical_pages;
  251.   unsigned long free_linear_space;
  252.   unsigned long max_pages_in_paging_file;
  253.   unsigned long reserved[3];
  254. } _go32_dpmi_meminfo;
  255.  
  256. #define _go32_dpmi_get_free_memory_information(x) __dpmi_get_free_memory_information((__dpmi_free_mem_info *)(x))
  257.  
  258. #define _go32_dpmi_simulate_int        __dpmi_simulate_real_mode_interrupt
  259. #define _go32_dpmi_simulate_fcall    __dpmi_simulate_real_mode_procedure_retf
  260. #define _go32_dpmi_simulate_fcall_iret    __dpmi_simulate_real_mode_procedure_iret
  261.  
  262. typedef struct {
  263.   unsigned long size;
  264.   unsigned long pm_offset;
  265.   unsigned short pm_selector;
  266.   unsigned short rm_offset;
  267.   unsigned short rm_segment;
  268. } _go32_dpmi_seginfo;
  269.  
  270. /* returns zero if success, else dpmi error and info->size is max size */
  271. int _go32_dpmi_allocate_dos_memory(_go32_dpmi_seginfo *info);
  272.     /* set size to bytes/16, call, use rm_segment.  Do not
  273.        change anthing but size until the memory is freed.
  274.        If error, max size is returned in size as bytes/16. */
  275. int _go32_dpmi_free_dos_memory(_go32_dpmi_seginfo *info);
  276.     /* set new size to bytes/16, call.  If error, max size
  277.        is returned in size as bytes/16 */
  278. int _go32_dpmi_resize_dos_memory(_go32_dpmi_seginfo *info);
  279.     /* uses pm_selector to free memory */
  280.  
  281. /* These both use the rm_segment:rm_offset fields only */
  282. int _go32_dpmi_get_real_mode_interrupt_vector(int vector, _go32_dpmi_seginfo *info);
  283. int _go32_dpmi_set_real_mode_interrupt_vector(int vector, _go32_dpmi_seginfo *info);
  284.  
  285. /* These do NOT wrap the function in pm_offset in an iret handler.
  286.    You must provide an assembler interface yourself, or alloc one below.
  287.    You may NOT longjmp out of an interrupt handler. */
  288. int _go32_dpmi_get_protected_mode_interrupt_vector(int vector, _go32_dpmi_seginfo *info);
  289.     /* puts vector in pm_selector:pm_offset. */
  290. int _go32_dpmi_set_protected_mode_interrupt_vector(int vector, _go32_dpmi_seginfo *info);
  291.     /* sets vector from pm_offset and pm_selector */
  292.  
  293. /********** HELPER FUNCTIONS **********/
  294.  
  295. int _go32_dpmi_chain_protected_mode_interrupt_vector(int vector, _go32_dpmi_seginfo *info);
  296.     /* sets up wrapper that calls function in pm_offset, chaining to old
  297.        handler when it returns */
  298.  
  299. /* These generate assember IRET-style wrappers for functions and set up stack */
  300. int _go32_dpmi_allocate_iret_wrapper(_go32_dpmi_seginfo *info);
  301.     /* Put function ptr in pm_offset, call, returns wrapper entry in pm_offset. */
  302. int _go32_dpmi_free_iret_wrapper(_go32_dpmi_seginfo *info);
  303.     /* assumes pm_offset points to wrapper, frees it */
  304.  
  305. /* RMCB functions, automatically restructure the real-mode stack for the 
  306.    proper return type and set up correct PM stack.  The callback
  307.    (info->pm_offset) is called as (*pmcb)(_go32_dpmi_registers *regs); */
  308. int _go32_dpmi_allocate_real_mode_callback_retf(_go32_dpmi_seginfo *info, _go32_dpmi_registers *regs);
  309.     /* points callback at pm_offset, returns seg:ofs of callback addr
  310.        in rm_segment:rm_offset.  Do not change any fields until freed.
  311.        Interface is added to simulate far return */
  312. int _go32_dpmi_allocate_real_mode_callback_iret(_go32_dpmi_seginfo *info, _go32_dpmi_registers *regs);
  313.     /* same, but simulates iret */
  314. int _go32_dpmi_free_real_mode_callback(_go32_dpmi_seginfo *info);
  315.     /* frees callback */
  316.  
  317. /* The following two variables may be used to change the default stack size
  318.    for interrupts and rmcb wrappers to a user defined size from the default
  319.    of 32Kbytes.  Each RMCB and chain/iret wrapper gets it's own stack. */
  320.  
  321. extern unsigned long _go32_interrupt_stack_size;
  322. extern unsigned long _go32_rmcb_stack_size;
  323.  
  324. /* Convenience functions, the return value is *bytes* */
  325. unsigned long _go32_dpmi_remaining_physical_memory(void);
  326. unsigned long _go32_dpmi_remaining_virtual_memory(void);
  327.  
  328. /* locks memory from a specified offset within the code/data selector */
  329. int _go32_dpmi_lock_code( void *_lockaddr, unsigned long _locksize);
  330. int _go32_dpmi_lock_data( void *_lockaddr, unsigned long _locksize);
  331.  
  332. int __djgpp_set_page_attributes(void *our_addr, unsigned long num_bytes,
  333.                     unsigned short attributes);
  334. int __djgpp_map_physical_memory(void *our_addr, unsigned long num_bytes,
  335.                     unsigned long phys_addr);
  336.  
  337. #endif /* !_POSIX_SOURCE */
  338. #endif /* !__STRICT_ANSI__ */
  339. #endif /* !__dj_ENFORCE_ANSI_FREESTANDING */
  340.  
  341. #ifndef __dj_ENFORCE_FUNCTION_CALLS
  342. #endif /* !__dj_ENFORCE_FUNCTION_CALLS */
  343.  
  344. #ifdef __cplusplus
  345. }
  346. #endif
  347.  
  348. #endif /* !__dj_include_dpmi_h_ */
  349.