/*
* CDDL HEADER START
*
* 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
* 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]
*
* CDDL HEADER END
*/
/*
*/
#ifndef _SYS_DAMAP_H
#define _SYS_DAMAP_H
#ifdef __cplusplus
extern "C" {
#endif
/*
* Delta (device) Address Map Interfaces
*
* These interfaces provide time-stablized sets of 'addresses',
* where addresses are string representations of device
* or bus-specific address. The mechanisms include interfaces to
* report and remove address from a map, time stabilization, callouts
* to higher-level configuration and unconfiguration actions, and
* address lookup functions.
*
* Per Address Reports
* With per-address reporting, the caller reports the addition and removal
* each address visible to it. Each report is independently time stabilized;
* Once a report has stabilized, the reported address is either
* activated & configured, or unconfigured & released.
*
* Full Set Reports
* When using fullset reporting, the report provider enumerates the entire
* set of addresses visible to the provider at a given point in time.
* The entire set is then stabilized.
* Upon stabilizing, any newly reported addresses are activated & configured
* and any previously active addresses which are no longer visible are
* automatically unconfigured and released, freeing the provider from
* the need to explicitly unconfigure addresses no longer present.
*
* Stabilization
* Once an address has been reported (or reported as removed), the report
* is time stabilized before the framework initiates a configuration
* or unconfiguration action. If the address is re-reported while undergoing
* stabilization, the timer is reset for either the address or the full
* set of addresses reported to the map.
*
* Once a reported address has passed its stabilization, the address is
* 'activated' by the framework. Once activated, the address is passed
* to a configuration callout to perform whatever actions are necessary.
* If a reported address is deleted or fails to stabilize, the address
* is released by the map.
* A report provider may register callback functions to be invoked
* as part of the address activation & release process. In addition to
* the callbacks, a provider can also supply a handle to provider-private
* data at the time an address is reported. This handle is returned to
* provider as an argument to the activation & release callbacks.
*
* The set of stable addresses contained in a map can be obtained by
* calling interfaces to lookup either a single address or the full
* list of stable addresses.
*/
/*
* damap_t: Handle to a delta address map
* damap_id_t: Handle to an entry of damap_t
*/
/*
* damap_id_list_t: List of damap_id_handles
* NB. Not Used
*/
/*
* activate_cb: Provider callback when reported address is activated
* deactivate_cb: Provider callback when address has been released
*
* configure_cb: Class callout to configure newly activated addresses
* unconfig_cb: Class callout to unconfigure deactivated addresses
*/
typedef enum {
DAMAP_DEACT_RSN_GONE = 0,
typedef void (*damap_activate_cb_t)(void *, char *, int, void **);
typedef void (*damap_deactivate_cb_t)(void *, char *, int, void *,
/*
* Map reporting mode
*/
/*
* Map create options flags
* DAMAP_SERIALCONFIG - serialize activate/deactivate operations
*/
#define DAMAP_SERIALCONFIG 0
int damap_create(char *, damap_rptmode_t, int, int,
void *, damap_activate_cb_t, damap_deactivate_cb_t,
void *, damap_configure_cb_t, damap_unconfig_cb_t,
damap_t **);
void damap_destroy(damap_t *);
char *damap_name(damap_t *);
int damap_size(damap_t *);
int damap_is_empty(damap_t *);
int damap_sync(damap_t *, int);
int damap_addr_del(damap_t *, char *);
int damap_addrid_del(damap_t *, int);
/*
* modifiers to damap_addrset_end()
*/
int damap_addrset_begin(damap_t *);
nvlist_t *, void *);
int damap_addrset_end(damap_t *, int);
int damap_addrset_flush(damap_t *);
int damap_addrset_reset(damap_t *, int);
#define DAM_SUCCESS 0
#ifdef __cplusplus
}
#endif
#endif /* _SYS_DAMAP_H */