io/heci/heci_data_structures.h

617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Use is subject to license terms.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Part of Intel(R) Manageability Engine Interface Linux driver
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Copyright (c) 2003 - 2008 Intel Corp.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * All rights reserved.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Redistribution and use in source and binary forms, with or without
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * modification, are permitted provided that the following conditions
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * are met:
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * 1. Redistributions of source code must retain the above copyright
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *    notice, this list of conditions, and the following disclaimer,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *    without modification.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * 2. Redistributions in binary form must reproduce at minimum a disclaimer
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *    substantially similar to the "NO WARRANTY" disclaimer below
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *    ("Disclaimer") and any redistribution must be conditioned upon
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *    including a substantially similar Disclaimer requirement for further
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *    binary redistribution.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * 3. Neither the names of the above-listed copyright holders nor the names
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *    of any contributors may be used to endorse or promote products derived
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *    from this software without specific prior written permission.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Alternatively, this software may be distributed under the terms of the
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * GNU General Public License ("GPL") version 2 as published by the Free
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Software Foundation.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * NO WARRANTY
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * POSSIBILITY OF SUCH DAMAGES.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#ifndef _HECI_DATA_STRUCTURES_H_
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define _HECI_DATA_STRUCTURES_H_
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#include <sys/varargs.h>
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#include <sys/types.h>
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#ifndef SUNOS
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define SUNOS
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#endif
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * error code definition
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define ESLOTS_OVERFLOW 1
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define ECORRUPTED_MESSAGE_HEADER   1000
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define ECOMPLETE_MESSAGE   1001
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_FC_MESSAGE_RESERVED_LENGTH 5
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Number of queue lists used by this driver
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_IO_LISTS_NUMBER    7
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Maximum transmission unit (MTU) of heci messages
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define IAMTHIF_MTU 4160
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#pragma pack(1)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * HECI HW Section
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* HECI registers */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* H_CB_WW - Host Circular Buffer (CB) Write Window register */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define H_CB_WW 0
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* H_CSR - Host Control Status register */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define H_CSR   4
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* ME_CB_RW - ME Circular Buffer Read Window register (read only) */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define ME_CB_RW    8
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* ME_CSR_HA - ME Control Status Host Access register (read only) */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define ME_CSR_HA   0xC
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* register bits of H_CSR (Host Control Status register) */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* Host Circular Buffer Depth - maximum number of 32-bit entries in CB */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define H_CBD   0xFF000000
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* Host Circular Buffer Write Pointer */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define H_CBWP  0x00FF0000
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* Host Circular Buffer Read Pointer */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define H_CBRP  0x0000FF00
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* Host Reset */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define H_RST   0x00000010
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* Host Ready */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define H_RDY   0x00000008
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* Host Interrupt Generate */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define H_IG    0x00000004
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* Host Interrupt Status */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define H_IS    0x00000002
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* Host Interrupt Enable */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define H_IE    0x00000001
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * register bits of ME_CSR_HA (ME Control Status Host Access register)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * ME CB (Circular Buffer) Depth HRA (Host Read Access)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *  - host read only access to ME_CBD
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define ME_CBD_HRA  0xFF000000
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* ME CB Write Pointer HRA - host read only access to ME_CBWP */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define ME_CBWP_HRA 0x00FF0000
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* ME CB Read Pointer HRA - host read only access to ME_CBRP */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define ME_CBRP_HRA 0x0000FF00
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* ME Reset HRA - host read only access to ME_RST */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define ME_RST_HRA  0x00000010
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* ME Ready HRA - host read only access to ME_RDY */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define ME_RDY_HRA  0x00000008
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* ME Interrupt Generate HRA - host read only access to ME_IG */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define ME_IG_HRA   0x00000004
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* ME Interrupt Status HRA - host read only access to ME_IS */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define ME_IS_HRA   0x00000002
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* ME Interrupt Enable HRA - host read only access to ME_IE */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define ME_IE_HRA   0x00000001
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_MINOR_NUMBER   1
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* #define  HECI_PTHI_MINOR_NUMBER  0 */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define MAKE_MINOR_NUM(minor, instance) (((uint_t)(minor) << 8) \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan                    | ((instance) & 0xFF))
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_MINOR_TO_INSTANCE(x)   ((x) & 0xFF)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_MINOR_TO_IFNUM(x)      (((x) >> 8) & 0xFF)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_MAX_OPEN_HANDLE_COUNT  253
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * debug kernel print macro define
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define PRN(...)    _PRN("%s():  "__VA_ARGS__, "")
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define _PRN(format, ...)                   \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    cmn_err(CE_CONT, format"%s", __func__, __VA_ARGS__)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#ifdef DEBUG
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganextern int heci_debug;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define DBG(...) { if (heci_debug) PRN(__VA_ARGS__); }
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#else
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define DBG
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#endif
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define assert(expr) \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    if (!(expr)) {                                   \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        cmn_err(CE_WARN, "Assertion failed! %s,%s,line=%d", #expr, \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        __FILE__, __LINE__);          \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    }
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define list_next(p)    ((p)->list_next)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define walk_list(p, n, h) \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    for (p = list_next(h), n = list_next(p);    \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        p != (h); \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        p = n, n = list_next(p))
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define list_init(ptr) { \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    (ptr)->list_next = (ptr); (ptr)->list_prev = (ptr); \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan}
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define LIST_INIT_HEAD  list_init
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define list_del_init(n)    { \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        list_del(n); \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        list_init(n); \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    }
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define list_empty(l)   ((l)->list_next == (l))
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define list_del(p) { (p)->list_next->list_prev = (p)->list_prev; \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    (p)->list_prev->list_next = (p)->list_next; }
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define list_add_tail(newnode, head) { \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        (head)->list_prev->list_next = (newnode); \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        (newnode)->list_prev = (head)->list_prev; \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        (head)->list_prev = (newnode); \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        (newnode)->list_next = (head); \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    }
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define list_relink_node(newnode, head) { \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        list_del(newnode); \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        list_add_tail(newnode, head); \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    }
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#ifdef __GNUC__
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define find_struct(ptr, type, member) ( \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    { \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    const __typeof(((type *)0)->member) *__tmpp = (ptr);  \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    (type *)(void *)((char *)__tmpp - ((size_t)&((type *)0)->member)); \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    })
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#else
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* type unsafe version */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define find_struct(ptr, type, member) \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        ((type *)(void *)((char *)(ptr) \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        - ((size_t)&((type *)0)->member)))
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#endif
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define list_for_each_entry_safe(pos, n, head, member, type)                  \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    for (pos = find_struct((head)->list_next, type, member),      \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        n = find_struct(pos->member.list_next, type, member); \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        &pos->member != (head);                                    \
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        pos = n, n = find_struct(n->member.list_next, type, member))
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HZ      drv_usectohz(1000000)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * time to wait HECI become ready after init
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_INTEROP_TIMEOUT    (HZ * 7)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * watch dog definition
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_WATCHDOG_DATA_SIZE 16
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_START_WD_DATA_SIZE 20
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_WD_PARAMS_SIZE 4
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_WD_HOST_CLIENT_ID  1
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_IAMTHIF_HOST_CLIENT_ID 2
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct guid {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t data1;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint16_t data2;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint16_t data3;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t data4[8];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* File state */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganenum file_state {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_FILE_INITIALIZING = 0,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_FILE_CONNECTING,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_FILE_CONNECTED,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_FILE_DISCONNECTING,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_FILE_DISCONNECTED
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* HECI device states */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganenum heci_states {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_INITIALIZING = 0,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_ENABLED,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_RESETING,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_DISABLED,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_RECOVERING_FROM_RESET,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_POWER_DOWN,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_POWER_UP
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganenum iamthif_states {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_IAMTHIF_IDLE,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_IAMTHIF_WRITING,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_IAMTHIF_FLOW_CONTROL,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_IAMTHIF_READING,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_IAMTHIF_READ_COMPLETE
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganenum heci_file_transaction_states {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_IDLE,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_WRITING,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_WRITE_COMPLETE,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_FLOW_CONTROL,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_READING,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_READ_COMPLETE
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* HECI CB */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganenum heci_cb_major_types {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_READ = 0,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_WRITE,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_IOCTL,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_OPEN,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    HECI_CLOSE
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* HECI user data struct */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct heci_message_data {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t size;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    char *data;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#ifndef  _LP64
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    char *pad;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#endif
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_CONNECT_TIMEOUT    3   /* at least 2 seconds */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define IAMTHIF_STALL_TIMER 12  /* seconds */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define IAMTHIF_READ_TIMER  15  /* seconds */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct heci_file {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    void * private_data;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct heci_cb_private {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct list_node cb_list;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    enum heci_cb_major_types major_file_operations;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    void *file_private;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct heci_message_data request_buffer;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct heci_message_data response_buffer;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    unsigned long information;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    unsigned long read_time;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct heci_file *file_object;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct io_heci_list {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct heci_cb_private heci_cb;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int status;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct iamt_heci_device *device_extension;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct heci_driver_version {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t major;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t minor;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t hotfix;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint16_t build;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct heci_client {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t max_message_length;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t protocol_version;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *  HECI BUS Interface Section
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct heci_msg_hdr {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t me_addr:8;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t host_addr:8;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t length:9;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t reserved:6;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t msg_complete:1;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_cmd {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t cmd:7;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t is_response:1;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct heci_bus_message {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_cmd cmd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t command_specific_data[];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_version {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t minor_version;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t major_version;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_host_version_request {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_cmd cmd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t reserved;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_version host_version;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_host_version_response {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_cmd cmd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int host_version_supported;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_version me_max_version;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_host_stop_request {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_cmd cmd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t reason;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t reserved[2];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_host_stop_response {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_cmd cmd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t reserved[3];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_me_stop_request {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_cmd cmd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t reason;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t reserved[2];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_host_enum_request {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_cmd cmd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t reserved[3];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_host_enum_response {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_cmd cmd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t reserved[3];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t valid_addresses[32];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct heci_client_properties {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct guid protocol_name;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t protocol_version;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t max_number_of_connections;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t fixed_address;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t single_recv_buf;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t max_msg_length;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_props_request {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_cmd cmd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t address;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t reserved[2];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_props_response {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_cmd cmd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t address;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t status;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t reserved[1];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct heci_client_properties client_properties;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_client_connect_request {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_cmd cmd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t me_addr;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t host_addr;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t reserved;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_client_connect_response {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_cmd cmd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t me_addr;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t host_addr;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t status;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_client_disconnect_request {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_cmd cmd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t me_addr;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t host_addr;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t reserved[1];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct hbm_flow_control {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_cmd cmd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t me_addr;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t host_addr;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t reserved[HECI_FC_MESSAGE_RESERVED_LENGTH];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct heci_me_client {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct heci_client_properties props;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t client_id;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t flow_ctrl_creds;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#pragma pack()
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* Private file struct */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct heci_file_private {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct list_node link;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct heci_file *file;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    enum file_state state;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct pollhead tx_pollwait;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    kcondvar_t  rx_wait;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct pollhead pollwait;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    kmutex_t file_lock;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    kmutex_t read_io_lock;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    kmutex_t write_io_lock;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int read_pending;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int status;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    /* ID of client connected */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t host_client_id;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t me_client_id;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t flow_ctrl_creds;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t timer_count;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    enum heci_file_transaction_states reading_state;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    enum heci_file_transaction_states writing_state;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int sm_state;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct heci_cb_private *read_cb;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/* private device struct */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct iamt_heci_device {
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    dev_info_t  *dip;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    ddi_acc_handle_t io_handle;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    ddi_iblock_cookie_t sc_iblk;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    /*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan     * lists of queues
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan     */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    /* array of pointers to  aio lists */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct io_heci_list *io_list_array[HECI_IO_LISTS_NUMBER];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct io_heci_list read_list;  /* driver read queue */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct io_heci_list write_list; /* driver write queue */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct io_heci_list write_waiting_list; /* write waiting queue */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct io_heci_list ctrl_wr_list;   /* managed write IOCTL list */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct io_heci_list ctrl_rd_list;   /* managed read IOCTL list */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct io_heci_list pthi_cmd_list;  /* PTHI list for cmd waiting */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    /* driver managed PTHI list for reading completed pthi cmd data */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct io_heci_list pthi_read_complete_list;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    /*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan     * list of files
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan     */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct list_node file_list;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    /*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan     * memory of device
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan     */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    char *mem_addr;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    /*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan     * lock for the device
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan     */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    kmutex_t device_lock;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    ddi_taskq_t *work;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int recvd_msg;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    ddi_taskq_t *reinit_tsk;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    timeout_id_t wd_timer;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    /*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan     * hw states of host and fw(ME)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan     */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t host_hw_state;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t me_hw_state;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    /*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan     * waiting queue for receive message from FW
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan     */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    kcondvar_t wait_recvd_msg;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    kcondvar_t wait_stop_wd;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    /*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan     * heci device  states
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan     */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    enum heci_states heci_state;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int stop;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t extra_write_index;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t rd_msg_buf[128];   /* used for control messages */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t wr_msg_buf[128];   /* used for control messages */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t ext_msg_buf[8];    /* for control responses    */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t rd_msg_hdr;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct hbm_version version;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int host_buffer_is_empty;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct heci_file_private wd_file_ext;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct heci_me_client *me_clients; /* Note: need to be allocated */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t heci_me_clients[32];    /* list of existing clients */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t num_heci_me_clients;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t heci_host_clients[32];  /* list of existing clients */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t current_host_client_id;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int wd_pending;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int wd_stoped;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint16_t wd_timeout;    /* seconds ((wd_data[1] << 8) + wd_data[0]) */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    unsigned char wd_data[HECI_START_WD_DATA_SIZE];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint16_t wd_due_counter;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int asf_mode;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int wd_bypass;  /* if 1, don't refresh watchdog ME client */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct heci_file *iamthif_file_object;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct heci_file_private iamthif_file_ext;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int iamthif_ioctl;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int iamthif_canceled;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t iamthif_timer;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t iamthif_stall_timer;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct heci_file files[256]; /* a file handle for each client */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    unsigned char iamthif_msg_buf[IAMTHIF_MTU];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t iamthif_msg_buf_size;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint32_t iamthif_msg_buf_index;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int iamthif_flow_control_pending;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    enum iamthif_states iamthif_state;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    struct heci_cb_private *iamthif_current_cb;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    uint8_t write_hang;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    int need_reset;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan    long open_handle_count;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan};
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * read_heci_register - Read a byte from the heci device
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * @device: the device structure
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * @offset: offset from which to read the data
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * @return the byte read.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganuint32_t read_heci_register(struct iamt_heci_device *device,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan                unsigned long offset);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * write_heci_register - Write  4 bytes to the heci device
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * @device: the device structure
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * @offset: offset from which to write the data
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * @value: the byte to write
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganvoid write_heci_register(struct iamt_heci_device *device, unsigned long offset,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan        uint32_t value);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define UIO_OFFSET(p)   (((struct uio *)p)->uio_offset)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define UIO_LENGTH(p)   (((struct uio *)p)->uio_resid)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define UIO_BUFF(p) ((char *)((struct uio *)p)->uio_iov->iov_base)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#endif /* _HECI_DATA_STRUCTURES_H_ */