/* SPDX-License-Identifier: GPL-2.0 */ /* * Copyright (c) 2012, The Linux Foundation. All rights reserved. */ #ifndef _LINUX_CORESIGHT_H #define _LINUX_CORESIGHT_H #include <linux/amba/bus.h> #include <linux/clk.h> #include <linux/device.h> #include <linux/io.h> #include <linux/perf_event.h> #include <linux/sched.h> #include <linux/platform_device.h> /* Peripheral id registers (0xFD0-0xFEC) */ #define CORESIGHT_PERIPHIDR4 … #define CORESIGHT_PERIPHIDR5 … #define CORESIGHT_PERIPHIDR6 … #define CORESIGHT_PERIPHIDR7 … #define CORESIGHT_PERIPHIDR0 … #define CORESIGHT_PERIPHIDR1 … #define CORESIGHT_PERIPHIDR2 … #define CORESIGHT_PERIPHIDR3 … /* Component id registers (0xFF0-0xFFC) */ #define CORESIGHT_COMPIDR0 … #define CORESIGHT_COMPIDR1 … #define CORESIGHT_COMPIDR2 … #define CORESIGHT_COMPIDR3 … #define ETM_ARCH_V3_3 … #define ETM_ARCH_V3_5 … #define PFT_ARCH_V1_0 … #define PFT_ARCH_V1_1 … #define CORESIGHT_UNLOCK … extern const struct bus_type coresight_bustype; enum coresight_dev_type { … }; enum coresight_dev_subtype_sink { … }; enum coresight_dev_subtype_link { … }; enum coresight_dev_subtype_source { … }; enum coresight_dev_subtype_helper { … }; /** * union coresight_dev_subtype - further characterisation of a type * @sink_subtype: type of sink this component is, as defined * by @coresight_dev_subtype_sink. * @link_subtype: type of link this component is, as defined * by @coresight_dev_subtype_link. * @source_subtype: type of source this component is, as defined * by @coresight_dev_subtype_source. * @helper_subtype: type of helper this component is, as defined * by @coresight_dev_subtype_helper. */ coresight_dev_subtype; /** * struct coresight_platform_data - data harvested from the firmware * specification. * * @nr_inconns: Number of elements for the input connections. * @nr_outconns: Number of elements for the output connections. * @out_conns: Array of nr_outconns pointers to connections from this * component. * @in_conns: Sparse array of pointers to input connections. Sparse * because the source device owns the connection so when it's * unloaded the connection leaves an empty slot. */ struct coresight_platform_data { … }; /** * struct csdev_access - Abstraction of a CoreSight device access. * * @io_mem : True if the device has memory mapped I/O * @base : When io_mem == true, base address of the component * @read : Read from the given "offset" of the given instance. * @write : Write "val" to the given "offset". */ struct csdev_access { … }; #define CSDEV_ACCESS_IOMEM(_addr) … /** * struct coresight_desc - description of a component required from drivers * @type: as defined by @coresight_dev_type. * @subtype: as defined by @coresight_dev_subtype. * @ops: generic operations for this component, as defined * by @coresight_ops. * @pdata: platform data collected from DT. * @dev: The device entity associated to this component. * @groups: operations specific to this component. These will end up * in the component's sysfs sub-directory. * @name: name for the coresight device, also shown under sysfs. * @access: Describe access to the device */ struct coresight_desc { … }; /** * struct coresight_connection - representation of a single connection * @src_port: a connection's output port number. * @dest_port: destination's input port number @src_port is connected to. * @dest_fwnode: destination component's fwnode handle. * @dest_dev: a @coresight_device representation of the component connected to @src_port. NULL until the device is created * @link: Representation of the connection as a sysfs link. * * The full connection structure looks like this, where in_conns store * references to same connection as the source device's out_conns. * * +-----------------------------+ +-----------------------------+ * |coresight_device | |coresight_connection | * |-----------------------------| |-----------------------------| * | | | | * | | | dest_dev*|<-- * |pdata->out_conns[nr_outconns]|<->|src_dev* | | * | | | | | * +-----------------------------+ +-----------------------------+ | * | * +-----------------------------+ | * |coresight_device | | * |------------------------------ | * | | | * | pdata->in_conns[nr_inconns]|<-- * | | * +-----------------------------+ */ struct coresight_connection { … }; /** * struct coresight_sysfs_link - representation of a connection in sysfs. * @orig: Originating (master) coresight device for the link. * @orig_name: Name to use for the link orig->target. * @target: Target (slave) coresight device for the link. * @target_name: Name to use for the link target->orig. */ struct coresight_sysfs_link { … }; /* architecturally we have 128 IDs some of which are reserved */ #define CORESIGHT_TRACE_IDS_MAX … /** * Trace ID map. * * @used_ids: Bitmap to register available (bit = 0) and in use (bit = 1) IDs. * Initialised so that the reserved IDs are permanently marked as * in use. * @perf_cs_etm_session_active: Number of Perf sessions using this ID map. */ struct coresight_trace_id_map { … }; /** * struct coresight_device - representation of a device as used by the framework * @pdata: Platform data with device connections associated to this device. * @type: as defined by @coresight_dev_type. * @subtype: as defined by @coresight_dev_subtype. * @ops: generic operations for this component, as defined * by @coresight_ops. * @access: Device i/o access abstraction for this device. * @dev: The device entity associated to this component. * @mode: This tracer's mode, i.e sysFS, Perf or disabled. This is * actually an 'enum cs_mode', but is stored in an atomic type. * This is always accessed through local_read() and local_set(), * but wherever it's done from within the Coresight device's lock, * a non-atomic read would also work. This is the main point of * synchronisation between code happening inside the sysfs mode's * coresight_mutex and outside when running in Perf mode. A compare * and exchange swap is done to atomically claim one mode or the * other. * @refcnt: keep track of what is in use. Only access this outside of the * device's spinlock when the coresight_mutex held and mode == * CS_MODE_SYSFS. Otherwise it must be accessed from inside the * spinlock. * @orphan: true if the component has connections that haven't been linked. * @sysfs_sink_activated: 'true' when a sink has been selected for use via sysfs * by writing a 1 to the 'enable_sink' file. A sink can be * activated but not yet enabled. Enabling for a _sink_ happens * when a source has been selected and a path is enabled from * source to that sink. A sink can also become enabled but not * activated if it's used via Perf. * @ea: Device attribute for sink representation under PMU directory. * @def_sink: cached reference to default sink found for this device. * @nr_links: number of sysfs links created to other components from this * device. These will appear in the "connections" group. * @has_conns_grp: Have added a "connections" group for sysfs links. * @feature_csdev_list: List of complex feature programming added to the device. * @config_csdev_list: List of system configurations added to the device. * @cscfg_csdev_lock: Protect the lists of configurations and features. * @active_cscfg_ctxt: Context information for current active system configuration. */ struct coresight_device { … }; /* * coresight_dev_list - Mapping for devices to "name" index for device * names. * * @nr_idx: Number of entries already allocated. * @pfx: Prefix pattern for device name. * @fwnode_list: Array of fwnode_handles associated with each allocated * index, upto nr_idx entries. */ struct coresight_dev_list { … }; #define DEFINE_CORESIGHT_DEVLIST(var, dev_pfx) … #define to_coresight_device(d) … enum cs_mode { … }; #define source_ops(csdev) … #define sink_ops(csdev) … #define link_ops(csdev) … #define helper_ops(csdev) … #define ect_ops(csdev) … /** * struct coresight_ops_sink - basic operations for a sink * Operations available for sinks * @enable: enables the sink. * @disable: disables the sink. * @alloc_buffer: initialises perf's ring buffer for trace collection. * @free_buffer: release memory allocated in @get_config. * @update_buffer: update buffer pointers after a trace session. */ struct coresight_ops_sink { … }; /** * struct coresight_ops_link - basic operations for a link * Operations available for links. * @enable: enables flow between iport and oport. * @disable: disables flow between iport and oport. */ struct coresight_ops_link { … }; /** * struct coresight_ops_source - basic operations for a source * Operations available for sources. * @cpu_id: returns the value of the CPU number this component * is associated to. * @enable: enables tracing for a source. * @disable: disables tracing for a source. */ struct coresight_ops_source { … }; /** * struct coresight_ops_helper - Operations for a helper device. * * All operations could pass in a device specific data, which could * help the helper device to determine what to do. * * @enable : Enable the device * @disable : Disable the device */ struct coresight_ops_helper { … }; struct coresight_ops { … }; static inline u32 csdev_access_relaxed_read32(struct csdev_access *csa, u32 offset) { … } #define CORESIGHT_CIDRn(i) … static inline u32 coresight_get_cid(void __iomem *base) { … } static inline bool is_coresight_device(void __iomem *base) { … } /* * Attempt to find and enable "APB clock" for the given device * * Returns: * * clk - Clock is found and enabled * NULL - clock is not found * ERROR - Clock is found but failed to enable */ static inline struct clk *coresight_get_enable_apb_pclk(struct device *dev) { … } #define CORESIGHT_PIDRn(i) … static inline u32 coresight_get_pid(struct csdev_access *csa) { … } static inline u64 csdev_access_relaxed_read_pair(struct csdev_access *csa, u32 lo_offset, u32 hi_offset) { … } static inline void csdev_access_relaxed_write_pair(struct csdev_access *csa, u64 val, u32 lo_offset, u32 hi_offset) { … } static inline u32 csdev_access_read32(struct csdev_access *csa, u32 offset) { … } static inline void csdev_access_relaxed_write32(struct csdev_access *csa, u32 val, u32 offset) { … } static inline void csdev_access_write32(struct csdev_access *csa, u32 val, u32 offset) { … } #ifdef CONFIG_64BIT static inline u64 csdev_access_relaxed_read64(struct csdev_access *csa, u32 offset) { … } static inline u64 csdev_access_read64(struct csdev_access *csa, u32 offset) { … } static inline void csdev_access_relaxed_write64(struct csdev_access *csa, u64 val, u32 offset) { … } static inline void csdev_access_write64(struct csdev_access *csa, u64 val, u32 offset) { … } #else /* !CONFIG_64BIT */ static inline u64 csdev_access_relaxed_read64(struct csdev_access *csa, u32 offset) { WARN_ON(1); return 0; } static inline u64 csdev_access_read64(struct csdev_access *csa, u32 offset) { WARN_ON(1); return 0; } static inline void csdev_access_relaxed_write64(struct csdev_access *csa, u64 val, u32 offset) { WARN_ON(1); } static inline void csdev_access_write64(struct csdev_access *csa, u64 val, u32 offset) { WARN_ON(1); } #endif /* CONFIG_64BIT */ static inline bool coresight_is_percpu_source(struct coresight_device *csdev) { … } static inline bool coresight_is_percpu_sink(struct coresight_device *csdev) { … } /* * Atomically try to take the device and set a new mode. Returns true on * success, false if the device is already taken by someone else. */ static inline bool coresight_take_mode(struct coresight_device *csdev, enum cs_mode new_mode) { … } static inline enum cs_mode coresight_get_mode(struct coresight_device *csdev) { … } static inline void coresight_set_mode(struct coresight_device *csdev, enum cs_mode new_mode) { … } extern struct coresight_device * coresight_register(struct coresight_desc *desc); extern void coresight_unregister(struct coresight_device *csdev); extern int coresight_enable_sysfs(struct coresight_device *csdev); extern void coresight_disable_sysfs(struct coresight_device *csdev); extern int coresight_timeout(struct csdev_access *csa, u32 offset, int position, int value); extern int coresight_claim_device(struct coresight_device *csdev); extern int coresight_claim_device_unlocked(struct coresight_device *csdev); extern void coresight_disclaim_device(struct coresight_device *csdev); extern void coresight_disclaim_device_unlocked(struct coresight_device *csdev); extern char *coresight_alloc_device_name(struct coresight_dev_list *devs, struct device *dev); extern bool coresight_loses_context_with_cpu(struct device *dev); u32 coresight_relaxed_read32(struct coresight_device *csdev, u32 offset); u32 coresight_read32(struct coresight_device *csdev, u32 offset); void coresight_write32(struct coresight_device *csdev, u32 val, u32 offset); void coresight_relaxed_write32(struct coresight_device *csdev, u32 val, u32 offset); u64 coresight_relaxed_read64(struct coresight_device *csdev, u32 offset); u64 coresight_read64(struct coresight_device *csdev, u32 offset); void coresight_relaxed_write64(struct coresight_device *csdev, u64 val, u32 offset); void coresight_write64(struct coresight_device *csdev, u64 val, u32 offset); extern int coresight_get_cpu(struct device *dev); struct coresight_platform_data *coresight_get_platform_data(struct device *dev); struct coresight_connection * coresight_add_out_conn(struct device *dev, struct coresight_platform_data *pdata, const struct coresight_connection *new_conn); int coresight_add_in_conn(struct coresight_connection *conn); struct coresight_device * coresight_find_input_type(struct coresight_platform_data *pdata, enum coresight_dev_type type, union coresight_dev_subtype subtype); struct coresight_device * coresight_find_output_type(struct coresight_platform_data *pdata, enum coresight_dev_type type, union coresight_dev_subtype subtype); int coresight_init_driver(const char *drv, struct amba_driver *amba_drv, struct platform_driver *pdev_drv); void coresight_remove_driver(struct amba_driver *amba_drv, struct platform_driver *pdev_drv); #endif /* _LINUX_COREISGHT_H */
Codebase Browser
linux