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 * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_DDI_IMPLFUNCS_H 27 #define _SYS_DDI_IMPLFUNCS_H 28 29 #pragma ident "%Z%%M% %I% %E% SMI" 30 31 #ifdef __cplusplus 32 extern "C" { 33 #endif 34 35 #include <sys/obpdefs.h> 36 #include <sys/vnode.h> 37 #include <sys/types.h> 38 #include <sys/task.h> 39 #include <sys/project.h> 40 41 #ifdef _KERNEL 42 43 /* 44 * Declare implementation functions that sunddi functions can 45 * call in order to perform their required task. Each kernel 46 * architecture must provide them. 47 */ 48 49 int 50 i_ddi_bus_map(dev_info_t *dip, dev_info_t *rdip, ddi_map_req_t *mp, 51 off_t offset, off_t len, caddr_t *vaddrp); 52 53 int 54 i_ddi_apply_range(dev_info_t *dip, dev_info_t *rdip, struct regspec *rp); 55 56 struct regspec * 57 i_ddi_rnumber_to_regspec(dev_info_t *dip, int rnumber); 58 59 60 int 61 i_ddi_map_fault(dev_info_t *dip, dev_info_t *rdip, 62 struct hat *hat, struct seg *seg, caddr_t addr, 63 struct devpage *dp, pfn_t pfn, uint_t prot, uint_t lock); 64 65 ddi_regspec_t 66 i_ddi_get_regspec(dev_info_t *dip, dev_info_t *rdip, uint_t rnumber, 67 off_t offset, off_t len); 68 69 /* 70 * Implementation specific memory allocation and de-allocation routines. 71 */ 72 int 73 i_ddi_mem_alloc(dev_info_t *dip, ddi_dma_attr_t *attributes, 74 size_t length, int cansleep, int streaming, 75 ddi_device_acc_attr_t *accattrp, caddr_t *kaddrp, 76 size_t *real_length, ddi_acc_hdl_t *handlep); 77 78 int 79 i_ddi_mem_alloc_lim(dev_info_t *dip, ddi_dma_lim_t *limits, 80 size_t length, int cansleep, int streaming, 81 ddi_device_acc_attr_t *accattrp, caddr_t *kaddrp, 82 uint_t *real_length, ddi_acc_hdl_t *handlep); 83 84 void 85 i_ddi_mem_free(caddr_t kaddr, int streaming); 86 87 int 88 i_ddi_devi_get_ppa(dev_info_t *dip); 89 90 void 91 i_ddi_devi_set_ppa(dev_info_t *dip, int ppa); 92 93 /* 94 * Access and DMA handle fault set/clear routines 95 */ 96 void 97 i_ddi_acc_set_fault(ddi_acc_handle_t handle); 98 void 99 i_ddi_acc_clr_fault(ddi_acc_handle_t handle); 100 void 101 i_ddi_dma_set_fault(ddi_dma_handle_t handle); 102 void 103 i_ddi_dma_clr_fault(ddi_dma_handle_t handle); 104 105 /* 106 * Event-handling functions for rootnex 107 * These provide the standard implementation of fault handling 108 */ 109 void 110 i_ddi_rootnex_init_events(dev_info_t *dip); 111 112 int 113 i_ddi_rootnex_get_eventcookie(dev_info_t *dip, dev_info_t *rdip, 114 char *eventname, ddi_eventcookie_t *cookiep); 115 int 116 i_ddi_rootnex_add_eventcall(dev_info_t *dip, dev_info_t *rdip, 117 ddi_eventcookie_t eventid, void (*handler)(dev_info_t *dip, 118 ddi_eventcookie_t event, void *arg, void *impl_data), void *arg, 119 ddi_callback_id_t *cb_id); 120 int 121 i_ddi_rootnex_remove_eventcall(dev_info_t *devi, ddi_callback_id_t cb_id); 122 123 int 124 i_ddi_rootnex_post_event(dev_info_t *dip, dev_info_t *rdip, 125 ddi_eventcookie_t eventid, void *impl_data); 126 127 /* 128 * Clustering: Return the global devices path base, or 129 * the entire global devices path prefix. 130 */ 131 const char * 132 i_ddi_get_dpath_base(); 133 134 const char * 135 i_ddi_get_dpath_prefix(); 136 137 /* 138 * Search and return properties from the PROM 139 */ 140 int 141 impl_ddi_bus_prop_op(dev_t dev, dev_info_t *dip, 142 dev_info_t *ch_dip, ddi_prop_op_t prop_op, int mod_flags, 143 char *name, caddr_t valuep, int *lengthp); 144 145 /* 146 * Copy an integer from PROM to native machine representation 147 */ 148 int 149 impl_ddi_prop_int_from_prom(uchar_t *intp, int n); 150 151 152 extern int impl_ddi_sunbus_initchild(dev_info_t *); 153 extern void impl_ddi_sunbus_removechild(dev_info_t *); 154 155 /* 156 * Implementation specific access handle allocator and init. routines 157 */ 158 extern ddi_acc_handle_t impl_acc_hdl_alloc(int (*waitfp)(caddr_t), 159 caddr_t arg); 160 extern void impl_acc_hdl_free(ddi_acc_handle_t handle); 161 162 extern ddi_acc_hdl_t *impl_acc_hdl_get(ddi_acc_handle_t handle); 163 extern void impl_acc_hdl_init(ddi_acc_hdl_t *hp); 164 165 /* access error handling support */ 166 extern void impl_acc_err_init(ddi_acc_hdl_t *); 167 extern int impl_dma_check(dev_info_t *, const void *, const void *, 168 const void *); 169 extern int i_ddi_ontrap(ddi_acc_handle_t); 170 extern void i_ddi_notrap(ddi_acc_handle_t); 171 extern int i_ddi_prot_trampoline(); 172 extern int i_ddi_caut_trampoline(); 173 174 /* 175 * misc/bootdev entry points - these are private routines and subject 176 * to change. 177 */ 178 extern int 179 i_devname_to_promname(char *dev_name, char *ret_buf, size_t); 180 181 extern int 182 i_promname_to_devname(char *prom_name, char *ret_buf); 183 184 extern char * 185 i_convert_boot_device_name(char *, char *, size_t *); 186 187 /* 188 * Nodeid management ... 189 */ 190 void impl_ddi_init_nodeid(void); 191 int impl_ddi_alloc_nodeid(int *nodeid); 192 int impl_ddi_take_nodeid(int nodeid, int kmflag); 193 void impl_ddi_free_nodeid(int nodeid); 194 195 /* 196 * minorname/devtspectype conversions 197 */ 198 extern char * 199 i_ddi_devtspectype_to_minorname(dev_info_t *dip, dev_t dev, int spec_type); 200 201 extern int 202 i_ddi_minorname_to_devtspectype(dev_info_t *dip, char *minor_name, 203 dev_t *devp, int *spectypep); 204 205 /* 206 * Routines in ddi_v9_asm.s 207 */ 208 extern int do_peek(size_t, void *, void *); 209 extern int do_poke(size_t, void *, void *); 210 extern void peek_fault(void); 211 extern void poke_fault(void); 212 extern int peekpoke_mem(ddi_ctl_enum_t, peekpoke_ctlops_t *); 213 214 /* 215 * Helper functions 216 */ 217 char *i_ddi_strdup(char *, uint_t); 218 void i_ddi_prop_list_delete(ddi_prop_t *); 219 ddi_prop_t *i_ddi_prop_list_dup(ddi_prop_t *, uint_t); 220 int i_ddi_load_drvconf(major_t); 221 int i_ddi_unload_drvconf(major_t); 222 ddi_node_state_t i_ddi_node_state(dev_info_t *); 223 int i_ddi_devi_attached(dev_info_t *); 224 void i_ddi_parse_name(char *, char **, char **, char **); 225 void i_ddi_set_node_state(dev_info_t *, ddi_node_state_t); 226 int i_ddi_detach_installed_driver(major_t, int); 227 void i_ddi_set_binding_name(dev_info_t *, char *); 228 void i_ddi_bind_devs(); 229 void i_ddi_unbind_devs(major_t); 230 ddi_prop_list_t *i_ddi_prop_list_create(ddi_prop_t *); 231 struct devnames; 232 void i_ddi_prop_list_hold(ddi_prop_list_t *, struct devnames *); 233 void i_ddi_prop_list_rele(ddi_prop_list_t *, struct devnames *); 234 ddi_prop_t *i_ddi_prop_search(dev_t, char *, uint_t, ddi_prop_t **); 235 int resolve_pathname(char *, dev_info_t **, dev_t *, int *); 236 int i_ddi_prompath_to_devfspath(char *, char *); 237 int i_ddi_attach_node_hierarchy(dev_info_t *); 238 dev_info_t *i_ddi_attach_pseudo_node(char *); 239 int i_ddi_attach_hw_nodes(char *); 240 int i_ddi_devs_attached(major_t); 241 242 /* non-DDI functions: wrapper around mod_hold/rele_dev_by_major() */ 243 struct dev_ops *ddi_hold_driver(major_t); 244 void ddi_rele_driver(major_t); 245 246 /* 247 * devid cache 248 */ 249 void i_ddi_devices_init(void); 250 void i_ddi_read_devices_files(void); 251 void i_ddi_clean_devices_files(void); 252 253 int i_ddi_devi_get_devid(dev_t, dev_info_t *, ddi_devid_t *); 254 255 int e_ddi_devid_discovery(ddi_devid_t); 256 257 int e_devid_cache_register(dev_info_t *, ddi_devid_t); 258 void e_devid_cache_unregister(dev_info_t *); 259 260 int e_devid_cache_to_devt_list(ddi_devid_t, char *, int *, dev_t **); 261 void e_devid_cache_free_devt_list(int, dev_t *); 262 263 /* 264 * Resource control functions to lock down device memory. 265 */ 266 extern int i_ddi_incr_locked_memory(proc_t *, task_t *, kproject_t *, 267 zone_t *, rctl_qty_t); 268 extern void i_ddi_decr_locked_memory(proc_t *, task_t *, kproject_t *, 269 zone_t *, rctl_qty_t); 270 271 #endif /* _KERNEL */ 272 273 #ifdef __cplusplus 274 } 275 #endif 276 277 #endif /* _SYS_DDI_IMPLFUNCS_H */ 278