linux-imx

// SPDX-License-Identifier: GPL-2.0

/*

 * Internal Thunderbolt Connection Manager. This is a firmware running on

 * the Thunderbolt host controller performing most of the low-level

 * handling.

 *

 * Copyright (C) 2017, Intel Corporation

 * Authors: Michael Jamet <michael.jamet@intel.com>

 *          Mika Westerberg <mika.westerberg@linux.intel.com>

 */

​

#include <linux/delay.h>

#include <linux/mutex.h>

#include <linux/pci.h>

#include <linux/pm_runtime.h>

#include <linux/platform_data/x86/apple.h>

#include <linux/sizes.h>

#include <linux/slab.h>

#include <linux/workqueue.h>

​

#include "ctl.h"

#include "nhi_regs.h"

#include "tb.h"

​

#define PCIE2CIO_CMD            0x30

#define PCIE2CIO_CMD_TIMEOUT        BIT(31)

#define PCIE2CIO_CMD_START      BIT(30)

#define PCIE2CIO_CMD_WRITE      BIT(21)

#define PCIE2CIO_CMD_CS_MASK        GENMASK(20, 19)

#define PCIE2CIO_CMD_CS_SHIFT       19

#define PCIE2CIO_CMD_PORT_MASK      GENMASK(18, 13)

#define PCIE2CIO_CMD_PORT_SHIFT     13

​

#define PCIE2CIO_WRDATA         0x34

#define PCIE2CIO_RDDATA         0x38

​

#define PHY_PORT_CS1            0x37

#define PHY_PORT_CS1_LINK_DISABLE   BIT(14)

#define PHY_PORT_CS1_LINK_STATE_MASK    GENMASK(29, 26)

#define PHY_PORT_CS1_LINK_STATE_SHIFT   26

​

#define ICM_TIMEOUT         5000    /* ms */

#define ICM_APPROVE_TIMEOUT     10000   /* ms */

#define ICM_MAX_LINK            4

#define ICM_MAX_DEPTH           6

​

/**

 * struct icm - Internal connection manager private data

 * @request_lock: Makes sure only one message is send to ICM at time

 * @rescan_work: Work used to rescan the surviving switches after resume

 * @upstream_port: Pointer to the PCIe upstream port this host

 *         controller is connected. This is only set for systems

 *         where ICM needs to be started manually

 * @vnd_cap: Vendor defined capability where PCIe2CIO mailbox resides

 *       (only set when @upstream_port is not %NULL)

 * @safe_mode: ICM is in safe mode

 * @max_boot_acl: Maximum number of preboot ACL entries (%0 if not supported)

 * @rpm: Does the controller support runtime PM (RTD3)

 * @is_supported: Checks if we can support ICM on this controller

 * @get_mode: Read and return the ICM firmware mode (optional)

 * @get_route: Find a route string for given switch

 * @save_devices: Ask ICM to save devices to ACL when suspending (optional)

 * @driver_ready: Send driver ready message to ICM

 * @device_connected: Handle device connected ICM message

 * @device_disconnected: Handle device disconnected ICM message

 * @xdomain_connected - Handle XDomain connected ICM message

 * @xdomain_disconnected - Handle XDomain disconnected ICM message

 */

struct icm {

    struct mutex request_lock;

    struct delayed_work rescan_work;

    struct pci_dev *upstream_port;

    size_t max_boot_acl;

    int vnd_cap;

    bool safe_mode;

    bool rpm;

    bool (*is_supported)(struct tb *tb);

    int (*get_mode)(struct tb *tb);

    int (*get_route)(struct tb *tb, u8 link, u8 depth, u64 *route);

    void (*save_devices)(struct tb *tb);

    int (*driver_ready)(struct tb *tb,

                enum tb_security_level *security_level,

                size_t *nboot_acl, bool *rpm);

    void (*device_connected)(struct tb *tb,

                 const struct icm_pkg_header *hdr);

    void (*device_disconnected)(struct tb *tb,

                    const struct icm_pkg_header *hdr);

    void (*xdomain_connected)(struct tb *tb,

                  const struct icm_pkg_header *hdr);

    void (*xdomain_disconnected)(struct tb *tb,

                     const struct icm_pkg_header *hdr);

};