/* SPDX-License-Identifier: GPL-2.0 */ /* * Intel(R) Trace Hub data structures * * Copyright (C) 2014-2015 Intel Corporation. */ #ifndef __INTEL_TH_H__ #define __INTEL_TH_H__ #include <linux/irqreturn.h> /* intel_th_device device types */ enum { … }; struct intel_th_device; /** * struct intel_th_output - descriptor INTEL_TH_OUTPUT type devices * @port: output port number, assigned by the switch * @type: GTH_{MSU,CTP,PTI} * @scratchpad: scratchpad bits to flag when this output is enabled * @multiblock: true for multiblock output configuration * @active: true when this output is enabled * @wait_empty: wait for device pipeline to be empty * * Output port descriptor, used by switch driver to tell which output * port this output device corresponds to. Filled in at output device's * probe time by switch::assign(). Passed from output device driver to * switch related code to enable/disable its port. */ struct intel_th_output { … }; /** * struct intel_th_drvdata - describes hardware capabilities and quirks * @tscu_enable: device needs SW to enable time stamping unit * @multi_is_broken: device has multiblock mode is broken * @has_mintctl: device has interrupt control (MINTCTL) register * @host_mode_only: device can only operate in 'host debugger' mode */ struct intel_th_drvdata { … }; #define INTEL_TH_CAP(_th, _cap) … /** * struct intel_th_device - device on the intel_th bus * @dev: device * @drvdata: hardware capabilities/quirks * @resource: array of resources available to this device * @num_resources: number of resources in @resource array * @type: INTEL_TH_{SOURCE,OUTPUT,SWITCH} * @id: device instance or -1 * @host_mode: Intel TH is controlled by an external debug host * @output: output descriptor for INTEL_TH_OUTPUT devices * @name: device name to match the driver */ struct intel_th_device { … }; #define to_intel_th_device(_d) … /** * intel_th_device_get_resource() - obtain @num'th resource of type @type * @thdev: the device to search the resource for * @type: resource type * @num: number of the resource */ static inline struct resource * intel_th_device_get_resource(struct intel_th_device *thdev, unsigned int type, unsigned int num) { … } /* * GTH, output ports configuration */ enum { … }; /** * intel_th_output_assigned() - if an output device is assigned to a switch port * @thdev: the output device * * Return: true if the device is INTEL_TH_OUTPUT *and* is assigned a port */ static inline bool intel_th_output_assigned(struct intel_th_device *thdev) { … } /** * struct intel_th_driver - driver for an intel_th_device device * @driver: generic driver * @probe: probe method * @remove: remove method * @assign: match a given output type device against available outputs * @unassign: deassociate an output type device from an output port * @prepare: prepare output port for tracing * @enable: enable tracing for a given output device * @disable: disable tracing for a given output device * @irq: interrupt callback * @activate: enable tracing on the output's side * @deactivate: disable tracing on the output's side * @fops: file operations for device nodes * @attr_group: attributes provided by the driver * * Callbacks @probe and @remove are required for all device types. * Switch device driver needs to fill in @assign, @enable and @disable * callbacks. */ struct intel_th_driver { … }; #define to_intel_th_driver(_d) … #define to_intel_th_driver_or_null(_d) … /* * Subdevice tree structure is as follows: * + struct intel_th device (pci; dev_{get,set}_drvdata() * + struct intel_th_device INTEL_TH_SWITCH (GTH) * + struct intel_th_device INTEL_TH_OUTPUT (MSU, PTI) * + struct intel_th_device INTEL_TH_SOURCE (STH) * * In other words, INTEL_TH_OUTPUT devices are children of INTEL_TH_SWITCH; * INTEL_TH_SWITCH and INTEL_TH_SOURCE are children of the intel_th device. */ static inline struct intel_th_device * to_intel_th_parent(const struct intel_th_device *thdev) { … } static inline struct intel_th *to_intel_th(const struct intel_th_device *thdev) { … } struct intel_th * intel_th_alloc(struct device *dev, const struct intel_th_drvdata *drvdata, struct resource *devres, unsigned int ndevres); void intel_th_free(struct intel_th *th); int intel_th_driver_register(struct intel_th_driver *thdrv); void intel_th_driver_unregister(struct intel_th_driver *thdrv); int intel_th_trace_enable(struct intel_th_device *thdev); int intel_th_trace_switch(struct intel_th_device *thdev); int intel_th_trace_disable(struct intel_th_device *thdev); int intel_th_set_output(struct intel_th_device *thdev, unsigned int master); int intel_th_output_enable(struct intel_th *th, unsigned int otype); enum th_mmio_idx { … }; #define TH_POSSIBLE_OUTPUTS … /* Total number of possible subdevices: outputs + GTH + STH */ #define TH_SUBDEVICE_MAX … #define TH_CONFIGURABLE_MASTERS … #define TH_MSC_MAX … /* Maximum IRQ vectors */ #define TH_NVEC_MAX … /** * struct intel_th - Intel TH controller * @dev: driver core's device * @thdev: subdevices * @hub: "switch" subdevice (GTH) * @resource: resources of the entire controller * @num_thdevs: number of devices in the @thdev array * @num_resources: number of resources in the @resource array * @irq: irq number * @num_irqs: number of IRQs is use * @id: this Intel TH controller's device ID in the system * @major: device node major for output devices */ struct intel_th { … }; static inline struct intel_th_device * to_intel_th_hub(struct intel_th_device *thdev) { … } /* * Register windows */ enum { … }; /* * Scratchpad bits: tell firmware and external debuggers * what we are up to. */ enum { … }; #endif
Codebase Browser
linux