linux-imx

/* SPDX-License-Identifier: GPL-2.0+ */

/*

 * PCI Express Hot Plug Controller Driver

 *

 * Copyright (C) 1995,2001 Compaq Computer Corporation

 * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)

 * Copyright (C) 2001 IBM Corp.

 * Copyright (C) 2003-2004 Intel Corporation

 *

 * All rights reserved.

 *

 * Send feedback to <greg@kroah.com>, <kristen.c.accardi@intel.com>

 *

 */

#ifndef _PCIEHP_H

#define _PCIEHP_H

​

#include <linux/types.h>

#include <linux/pci.h>

#include <linux/pci_hotplug.h>

#include <linux/delay.h>

#include <linux/mutex.h>

#include <linux/rwsem.h>

#include <linux/workqueue.h>

​

#include "../pcie/portdrv.h"

​

#define MY_NAME "pciehp"

​

extern bool pciehp_poll_mode;

extern int pciehp_poll_time;

extern bool pciehp_debug;

​

#define dbg(format, arg...)                     \

do {                                    \

    if (pciehp_debug)                       \

        printk(KERN_DEBUG "%s: " format, MY_NAME, ## arg);  \

} while (0)

#define err(format, arg...)                     \

    printk(KERN_ERR "%s: " format, MY_NAME, ## arg)

#define info(format, arg...)                        \

    printk(KERN_INFO "%s: " format, MY_NAME, ## arg)

#define warn(format, arg...)                        \

    printk(KERN_WARNING "%s: " format, MY_NAME, ## arg)

​

#define ctrl_dbg(ctrl, format, arg...)                  \

    do {                                \

        if (pciehp_debug)                   \

            dev_printk(KERN_DEBUG, &ctrl->pcie->device, \

                    format, ## arg);        \

    } while (0)

#define ctrl_err(ctrl, format, arg...)                  \

    dev_err(&ctrl->pcie->device, format, ## arg)

#define ctrl_info(ctrl, format, arg...)                 \

    dev_info(&ctrl->pcie->device, format, ## arg)

#define ctrl_warn(ctrl, format, arg...)                 \

    dev_warn(&ctrl->pcie->device, format, ## arg)

​

#define SLOT_NAME_SIZE 10

​

/**

 * struct controller - PCIe hotplug controller

 * @pcie: pointer to the controller's PCIe port service device

 * @slot_cap: cached copy of the Slot Capabilities register

 * @slot_ctrl: cached copy of the Slot Control register

 * @ctrl_lock: serializes writes to the Slot Control register

 * @cmd_started: jiffies when the Slot Control register was last written;

 *  the next write is allowed 1 second later, absent a Command Completed

 *  interrupt (PCIe r4.0, sec 6.7.3.2)

 * @cmd_busy: flag set on Slot Control register write, cleared by IRQ handler

 *  on reception of a Command Completed event

 * @queue: wait queue to wake up on reception of a Command Completed event,

 *  used for synchronous writes to the Slot Control register

 * @pending_events: used by the IRQ handler to save events retrieved from the

 *  Slot Status register for later consumption by the IRQ thread

 * @notification_enabled: whether the IRQ was requested successfully

 * @power_fault_detected: whether a power fault was detected by the hardware

 *  that has not yet been cleared by the user

 * @poll_thread: thread to poll for slot events if no IRQ is available,

 *  enabled with pciehp_poll_mode module parameter

 * @state: current state machine position

 * @state_lock: protects reads and writes of @state;

 *  protects scheduling, execution and cancellation of @button_work

 * @button_work: work item to turn the slot on or off after 5 seconds

 *  in response to an Attention Button press

 * @hotplug_slot: structure registered with the PCI hotplug core

 * @reset_lock: prevents access to the Data Link Layer Link Active bit in the

 *  Link Status register and to the Presence Detect State bit in the Slot

 *  Status register during a slot reset which may cause them to flap

 * @request_result: result of last user request submitted to the IRQ thread

 * @requester: wait queue to wake up on completion of user request,

 *  used for synchronous slot enable/disable request via sysfs