/*
 * 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
 * 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]
 *
 * CDDL HEADER END
 */

/*
 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
 */
/*
 * Copyright 2020 Joyent, Inc.
 */

#ifndef _DISK_H
#define _DISK_H

#include <sys/fm/protocol.h>
#include <fm/topo_mod.h>
#include <libdevinfo.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Topo plugin version */
#define DISK_VERSION                    TOPO_VERSION

/* Max. number of devices for thumper */
#define DEVID_MAX               48

/*
 * Given a /devices path for a whole disk, appending this extension gives the
 * path to a raw device that can be opened.
 */
#if defined(__i386) || defined(__amd64)
#define PHYS_EXTN       ":q,raw"
#elif defined(__sparc) || defined(__sparcv9)
#define PHYS_EXTN       ":c,raw"
#else
#error  Unknown architecture
#endif

/* Properties added to the "storage" pgroup: */
#define TOPO_PGROUP_STORAGE             "storage"
#define TOPO_STORAGE_LOGICAL_DISK_NAME  "logical-disk"
#define TOPO_STORAGE_MODEL              "model"
#define TOPO_STORAGE_MANUFACTURER       "manufacturer"
#define TOPO_STORAGE_SERIAL_NUM         "serial-number"
#define TOPO_STORAGE_FIRMWARE_REV       "firmware-revision"
#define TOPO_STORAGE_CAPACITY           "capacity-in-bytes"
#define TOPO_STORAGE_RPM                "speed-in-rpm"
#define TOPO_STORAGE_LOG_BLOCK_SIZE     "logical-block-size"
#define TOPO_STORAGE_PHYS_BLOCK_SIZE    "physical-block-size"

static const topo_pgroup_info_t io_pgroup = {
        TOPO_PGROUP_IO,
        TOPO_STABILITY_PRIVATE,
        TOPO_STABILITY_PRIVATE,
        1
};

static const topo_pgroup_info_t disk_auth_pgroup = {
        FM_FMRI_AUTHORITY,
        TOPO_STABILITY_PRIVATE,
        TOPO_STABILITY_PRIVATE,
        1
};

static const topo_pgroup_info_t storage_pgroup = {
        TOPO_PGROUP_STORAGE,
        TOPO_STABILITY_PRIVATE,
        TOPO_STABILITY_PRIVATE,
        1
};

/*
 * device node information.
 */
typedef struct dev_di_node {
        topo_list_t     ddn_list;       /* list of devices */

        /* the following two fields are always defined */
        char            *ddn_devid;     /* devid of device */
        char            *ddn_dpath;     /* path to devinfo (may be vhci) */
        char            **ddn_ppath;    /* physical path to device (phci) */
        /*
         * the ppath count also indicates number of target port and
         * possible number of attached port and bridge port.
         */
        int             ddn_ppath_count;

        char            *ddn_lpath;     /* logical path (public /dev name) */

        char            *ddn_mfg;       /* misc information about device */
        char            *ddn_model;
        char            *ddn_serial;
        char            *ddn_firm;
        char            *ddn_cap;
        uchar_t         ddn_dtype;      /* scsi inquiry device type. */

        char            **ddn_target_port;  /* target-port devinfo prop */
        char            **ddn_attached_port; /* attached-port devinfo prop */
        char            **ddn_bridge_port;  /* bridge-port devinfo prop */
} dev_di_node_t;

struct topo_list;

/* Methods shared with the ses module (disk_common.c) */
extern int dev_list_gather(topo_mod_t *, struct topo_list *);
extern void dev_list_free(topo_mod_t *, struct topo_list *);
extern int disk_declare_non_enumerated(topo_mod_t *, tnode_t *, tnode_t **);
extern int disk_declare_path(topo_mod_t *, tnode_t *,
    struct topo_list *, const char *);
extern int disk_declare_addr(topo_mod_t *, tnode_t *,
    struct topo_list *, const char *, tnode_t **);
extern int disk_declare_bridge(topo_mod_t *, tnode_t *,
    struct topo_list *, const char *, tnode_t **);
extern char *disk_auth_clean(topo_mod_t *, const char *);

#ifdef __cplusplus
}
#endif

#endif /* _DISK_H */