xref: /titanic_51/usr/src/man/man9f/ddi_poke.9f (revision c10c16dec587a0662068f6e2991c29ed3a9db943) 
 te
 Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved
 The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
 You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
 When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
 ddi_poke 9F "16 Jan 2006" "SunOS 5.11" "Kernel Functions for Drivers"
 NAME
ddi_poke, ddi_poke8, ddi_poke16, ddi_poke32, ddi_poke64, ddi_pokec, ddi_pokes,
ddi_pokel, ddi_poked - write a value to a location

 SYNOPSIS


#include <sys/ddi.h>
#include <sys/sunddi.h>



int ddi_poke8(dev_info_t *dip, int8_t *addr, int8_t value);






int ddi_poke16(dev_info_t *dip, int16_t *addr, int16_t value);






int ddi_poke32(dev_info_t *dip, int32_t *addr, int32_t value);






int ddi_poke64(dev_info_t *dip, int64_t *addr, int64_t value);




 INTERFACE LEVEL

Solaris DDI specific (Solaris DDI). The ddi_pokec(), ddi_pokes(),
ddi_pokel(), and ddi_poked() functions are obsolete. Use,
respectively, ddi_poke8(), ddi_poke16(), ddi_poke32(), and
ddi_poke64(), instead.

 PARAMETERS

dip


A pointer to the device's dev_info structure.





addr


Virtual address of the location to be written to.





value


Value to be written to the location.




 DESCRIPTION

These routines cautiously attempt to write a value to a specified virtual
address, using the parent nexus driver to assist in the process where
necessary.


If the address is not valid, or the value cannot be written without an error
occurring, an error code is returned.


These routines are most useful when first trying to establish the presence of a
given device on the system in a driver's probe(9E) or attach(9E)
routines.


On multiprocessing machines these routines can be extremely heavy-weight, so
use the ddi_peek(9F) routines instead if possible.

 RETURN VALUES

DDI_SUCCESS


The value was successfully written to the given virtual address.





DDI_FAILURE


An error occurred while trying to write to the location.




 CONTEXT

These functions can be called from user, interrupt, or kernel context.

 SEE ALSO

attach(9E), probe(9E), ddi_peek(9F)


Writing Device Drivers

 NOTES

The functions described in this manual page previously used symbolic names
which specified their data access size; the function names have been changed so
they now specify a fixed-width data size. See the following table for the new
name equivalents:







Previous NameNew Name
ddi_pokecddi_poke8
ddi_pokesddi_poke16
ddi_pokelddi_poke32
ddi_pokedddi_poke64