82 lines
2.4 KiB
C
82 lines
2.4 KiB
C
|
/* SPDX-License-Identifier: GPL-2.0 */
|
||
|
|
/*
|
||
|
|
* Data Object Exchange
|
||
|
|
* PCIe r6.0, sec 6.30 DOE
|
||
|
|
*
|
||
|
|
* Copyright (C) 2021 Huawei
|
||
|
|
* Jonathan Cameron <Jonathan.Cameron@huawei.com>
|
||
|
|
*
|
||
|
|
* Copyright (C) 2022 Intel Corporation
|
||
|
|
* Ira Weiny <ira.weiny@intel.com>
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef LINUX_PCI_DOE_H
|
||
|
|
#define LINUX_PCI_DOE_H
|
||
|
|
|
||
|
|
struct pci_doe_protocol {
|
||
|
|
u16 vid;
|
||
|
|
u8 type;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct pci_doe_mb;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* struct pci_doe_task - represents a single query/response
|
||
|
|
*
|
||
|
|
* @prot: DOE Protocol
|
||
|
|
* @request_pl: The request payload
|
||
|
|
* @request_pl_sz: Size of the request payload (bytes)
|
||
|
|
* @response_pl: The response payload
|
||
|
|
* @response_pl_sz: Size of the response payload (bytes)
|
||
|
|
* @rv: Return value. Length of received response or error (bytes)
|
||
|
|
* @complete: Called when task is complete
|
||
|
|
* @private: Private data for the consumer
|
||
|
|
* @work: Used internally by the mailbox
|
||
|
|
* @doe_mb: Used internally by the mailbox
|
||
|
|
*
|
||
|
|
* Payloads are treated as opaque byte streams which are transmitted verbatim,
|
||
|
|
* without byte-swapping. If payloads contain little-endian register values,
|
||
|
|
* the caller is responsible for conversion with cpu_to_le32() / le32_to_cpu().
|
||
|
|
*
|
||
|
|
* The payload sizes and rv are specified in bytes with the following
|
||
|
|
* restrictions concerning the protocol.
|
||
|
|
*
|
||
|
|
* 1) The request_pl_sz must be a multiple of double words (4 bytes)
|
||
|
|
* 2) The response_pl_sz must be >= a single double word (4 bytes)
|
||
|
|
* 3) rv is returned as bytes but it will be a multiple of double words
|
||
|
|
*
|
||
|
|
* NOTE there is no need for the caller to initialize work or doe_mb.
|
||
|
|
*/
|
||
|
|
struct pci_doe_task {
|
||
|
|
struct pci_doe_protocol prot;
|
||
|
|
__le32 *request_pl;
|
||
|
|
size_t request_pl_sz;
|
||
|
|
__le32 *response_pl;
|
||
|
|
size_t response_pl_sz;
|
||
|
|
int rv;
|
||
|
|
void (*complete)(struct pci_doe_task *task);
|
||
|
|
void *private;
|
||
|
|
|
||
|
|
/* No need for the user to initialize these fields */
|
||
|
|
struct work_struct work;
|
||
|
|
struct pci_doe_mb *doe_mb;
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* pci_doe_for_each_off - Iterate each DOE capability
|
||
|
|
* @pdev: struct pci_dev to iterate
|
||
|
|
* @off: u16 of config space offset of each mailbox capability found
|
||
|
|
*/
|
||
|
|
#define pci_doe_for_each_off(pdev, off) \
|
||
|
|
for (off = pci_find_next_ext_capability(pdev, off, \
|
||
|
|
PCI_EXT_CAP_ID_DOE); \
|
||
|
|
off > 0; \
|
||
|
|
off = pci_find_next_ext_capability(pdev, off, \
|
||
|
|
PCI_EXT_CAP_ID_DOE))
|
||
|
|
|
||
|
|
struct pci_doe_mb *pcim_doe_create_mb(struct pci_dev *pdev, u16 cap_offset);
|
||
|
|
bool pci_doe_supports_prot(struct pci_doe_mb *doe_mb, u16 vid, u8 type);
|
||
|
|
int pci_doe_submit_task(struct pci_doe_mb *doe_mb, struct pci_doe_task *task);
|
||
|
|
|
||
|
|
#endif
|