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