1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright 2010 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 /* 27 * Copyright 2012 Garrett D'Amore <garrett@damore.org>. All rights reserved. 28 */ 29 30 #ifndef _SYS_DDI_IMPLFUNCS_H 31 #define _SYS_DDI_IMPLFUNCS_H 32 33 #ifdef __cplusplus 34 extern "C" { 35 #endif 36 37 #include <sys/obpdefs.h> 38 #include <sys/vnode.h> 39 #include <sys/types.h> 40 #include <sys/task.h> 41 #include <sys/project.h> 42 43 #ifdef _KERNEL 44 45 /* 46 * Declare implementation functions that sunddi functions can call in order to 47 * perform their required task. Each kernel architecture must provide them. 48 */ 49 extern int i_ddi_bus_map(dev_info_t *dip, dev_info_t *rdip, ddi_map_req_t *mp, 50 off_t offset, off_t len, caddr_t *vaddrp); 51 extern int i_ddi_apply_range(dev_info_t *dip, dev_info_t *rdip, 52 struct regspec *rp); 53 extern struct regspec *i_ddi_rnumber_to_regspec(dev_info_t *dip, int rnumber); 54 extern int i_ddi_map_fault(dev_info_t *dip, dev_info_t *rdip, 55 struct hat *hat, struct seg *seg, caddr_t addr, 56 struct devpage *dp, pfn_t pfn, uint_t prot, uint_t lock); 57 58 /* 59 * Implementation-specific memory allocation and de-allocation routines 60 */ 61 extern int i_ddi_mem_alloc(dev_info_t *dip, ddi_dma_attr_t *attributes, 62 size_t length, int cansleep, int streaming, 63 ddi_device_acc_attr_t *accattrp, caddr_t *kaddrp, 64 size_t *real_length, ddi_acc_hdl_t *handlep); 65 extern void i_ddi_mem_free(caddr_t kaddr, ddi_acc_hdl_t *ap); 66 67 extern int i_ddi_devi_get_ppa(dev_info_t *); 68 extern void i_ddi_devi_set_ppa(dev_info_t *, int); 69 70 extern void i_ddi_devacc_to_hatacc(ddi_device_acc_attr_t *devaccp, 71 uint_t *hataccp); 72 extern void i_ddi_cacheattr_to_hatacc(uint_t flags, uint_t *hataccp); 73 extern boolean_t i_ddi_check_cache_attr(uint_t flags); 74 75 /* 76 * Access and DMA handle fault set/clear routines 77 */ 78 extern void i_ddi_acc_set_fault(ddi_acc_handle_t handle); 79 extern void i_ddi_acc_clr_fault(ddi_acc_handle_t handle); 80 extern void i_ddi_dma_set_fault(ddi_dma_handle_t handle); 81 extern void i_ddi_dma_clr_fault(ddi_dma_handle_t handle); 82 83 /* 84 * Event-handling functions for rootnex. 85 * These provide the standard implementation of fault handling. 86 */ 87 extern void i_ddi_rootnex_init_events(dev_info_t *); 88 extern int i_ddi_rootnex_get_eventcookie(dev_info_t *, dev_info_t *, char *, 89 ddi_eventcookie_t *); 90 extern int i_ddi_rootnex_add_eventcall(dev_info_t *, dev_info_t *, 91 ddi_eventcookie_t, void (*)(dev_info_t *, ddi_eventcookie_t, void *, 92 void *), void *, ddi_callback_id_t *); 93 extern int i_ddi_rootnex_remove_eventcall(dev_info_t *, ddi_callback_id_t); 94 extern int i_ddi_rootnex_post_event(dev_info_t *, dev_info_t *, 95 ddi_eventcookie_t, void *); 96 97 /* 98 * Search and return properties from the PROM 99 */ 100 extern int impl_ddi_bus_prop_op(dev_t, dev_info_t *, dev_info_t *, 101 ddi_prop_op_t, int, char *, caddr_t, int *); 102 103 /* 104 * Copy an integer from PROM to native machine representation 105 */ 106 extern int impl_ddi_prop_int_from_prom(uchar_t *intp, int n); 107 108 extern int impl_ddi_sunbus_initchild(dev_info_t *); 109 extern void impl_ddi_sunbus_removechild(dev_info_t *); 110 111 /* 112 * Implementation-specific access handle allocator and init. routines 113 */ 114 extern ddi_acc_handle_t impl_acc_hdl_alloc(int (*waitfp)(caddr_t), 115 caddr_t arg); 116 extern void impl_acc_hdl_free(ddi_acc_handle_t handle); 117 extern ddi_acc_hdl_t *impl_acc_hdl_get(ddi_acc_handle_t handle); 118 extern void impl_acc_hdl_init(ddi_acc_hdl_t *hp); 119 120 /* 121 * Access error handling support 122 */ 123 extern void impl_acc_err_init(ddi_acc_hdl_t *); 124 extern int impl_dma_check(dev_info_t *, const void *, const void *, 125 const void *); 126 extern int i_ddi_ontrap(ddi_acc_handle_t); 127 extern void i_ddi_notrap(ddi_acc_handle_t); 128 extern int i_ddi_prot_trampoline(void); 129 extern int i_ddi_caut_trampoline(void); 130 131 /* 132 * misc/bootdev entry points - these are private routines and subject 133 * to change 134 */ 135 extern int i_devname_to_promname(char *dev_name, char *ret_buf, size_t); 136 extern int i_promname_to_devname(char *prom_name, char *ret_buf); 137 extern char *i_convert_boot_device_name(char *, char *, size_t *); 138 139 /* 140 * Nodeid management 141 */ 142 extern void impl_ddi_init_nodeid(void); 143 extern int impl_ddi_alloc_nodeid(int *); 144 extern int impl_ddi_take_nodeid(int, int); 145 extern void impl_ddi_free_nodeid(int); 146 147 /* 148 * minorname/devtspectype conversions 149 */ 150 extern char *i_ddi_devtspectype_to_minorname(dev_info_t *, dev_t, int); 151 extern int i_ddi_minorname_to_devtspectype(dev_info_t *, char *, dev_t *, 152 int *); 153 154 /* 155 * Routines in ddi_v9_asm.s 156 */ 157 extern int do_peek(size_t, void *, void *); 158 extern int do_poke(size_t, void *, void *); 159 extern void peek_fault(void); 160 extern void poke_fault(void); 161 extern int peekpoke_mem(ddi_ctl_enum_t, peekpoke_ctlops_t *); 162 163 /* 164 * Helper functions 165 */ 166 extern char *i_ddi_strdup(char *, uint_t); 167 extern void i_ddi_prop_list_delete(ddi_prop_t *); 168 extern ddi_prop_t *i_ddi_prop_list_dup(ddi_prop_t *, uint_t); 169 extern int i_ddi_load_drvconf(major_t); 170 extern int i_ddi_unload_drvconf(major_t); 171 extern ddi_node_state_t i_ddi_node_state(dev_info_t *); 172 extern int i_ddi_devi_attached(dev_info_t *); 173 extern void i_ddi_parse_name(char *, char **, char **, char **); 174 extern void i_ddi_set_node_state(dev_info_t *, ddi_node_state_t); 175 extern int i_ddi_detach_installed_driver(major_t, int); 176 extern void i_ddi_set_binding_name(dev_info_t *, char *); 177 extern void i_ddi_bind_devs(void); 178 extern int i_ddi_unbind_devs_by_alias(major_t, char *); 179 extern void i_ddi_unbind_devs(major_t); 180 extern ddi_prop_list_t *i_ddi_prop_list_create(ddi_prop_t *); 181 struct devnames; 182 extern void i_ddi_prop_list_hold(ddi_prop_list_t *, struct devnames *); 183 extern void i_ddi_prop_list_rele(ddi_prop_list_t *, struct devnames *); 184 extern ddi_prop_t *i_ddi_prop_search(dev_t, char *, uint_t, ddi_prop_t **); 185 extern int resolve_pathname(char *, dev_info_t **, dev_t *, int *); 186 extern int i_ddi_prompath_to_devfspath(char *, char *); 187 extern int i_ddi_attach_node_hierarchy(dev_info_t *); 188 extern dev_info_t *i_ddi_attach_pseudo_node(char *); 189 extern int i_ddi_attach_hw_nodes(char *); 190 extern int i_ddi_devs_attached(major_t); 191 extern int i_ddi_minor_node_count(dev_info_t *, const char *); 192 extern int ddi_is_pci_dip(dev_info_t *dip); 193 194 /* 195 * Non-DDI functions: wrapper around mod_hold/rele_dev_by_major() 196 */ 197 extern struct dev_ops *ddi_hold_driver(major_t); 198 extern void ddi_rele_driver(major_t); 199 200 /* 201 * /etc/devices cache files management 202 */ 203 extern void i_ddi_devices_init(void); 204 extern void i_ddi_read_devices_files(void); 205 extern void i_ddi_clean_devices_files(void); 206 207 /* 208 * devid cache 209 */ 210 extern void devid_cache_init(void); 211 extern void devid_cache_read(void); 212 extern void devid_cache_cleanup(void); 213 extern int i_ddi_devi_get_devid(dev_t, dev_info_t *, ddi_devid_t *); 214 extern int e_ddi_devid_discovery(ddi_devid_t); 215 extern int e_devid_cache_register(dev_info_t *, ddi_devid_t); 216 extern void e_devid_cache_unregister(dev_info_t *); 217 extern int e_devid_cache_to_devt_list(ddi_devid_t, char *, int *, dev_t **); 218 extern void e_devid_cache_free_devt_list(int, dev_t *); 219 220 /* 221 * I/O retire persistent store 222 */ 223 extern void retire_store_init(void); 224 extern void retire_store_read(void); 225 extern int e_ddi_retire_persist(char *); 226 extern int e_ddi_retire_unpersist(char *); 227 extern int e_ddi_device_retired(char *); 228 229 /* 230 * Resource control functions to lock down device memory 231 */ 232 extern int i_ddi_incr_locked_memory(proc_t *, rctl_qty_t); 233 extern void i_ddi_decr_locked_memory(proc_t *, rctl_qty_t); 234 235 /* 236 * Direct I/O support functions 237 */ 238 extern void translate_devid(dev_info_t *dip); 239 240 #endif /* _KERNEL */ 241 242 #ifdef __cplusplus 243 } 244 #endif 245 246 #endif /* _SYS_DDI_IMPLFUNCS_H */ 247