/* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
/* Copyright(c) 2015-17 Intel Corporation. */

#ifndef __SOUNDWIRE_H
#define __SOUNDWIRE_H

#include <linux/bitfield.h>
#include <linux/bug.h>
#include <linux/completion.h>
#include <linux/device.h>
#include <linux/idr.h>
#include <linux/irq.h>
#include <linux/irqdomain.h>
#include <linux/lockdep_types.h>
#include <linux/mod_devicetable.h>
#include <linux/mutex.h>
#include <linux/types.h>
#include <sound/sdca.h>

struct dentry;
struct fwnode_handle;

struct sdw_bus;
struct sdw_slave;

/* SDW spec defines and enums, as defined by MIPI 1.1. Spec */

/* SDW Broadcast Device Number */
#define SDW_BROADCAST_DEV_NUM  15

/* SDW Enumeration Device Number */
#define SDW_ENUM_DEV_NUM  0

/* SDW Group Device Numbers */
#define SDW_GROUP12_DEV_NUM  12
#define SDW_GROUP13_DEV_NUM  13

/* SDW Master Device Number, not supported yet */
#define SDW_MASTER_DEV_NUM  14

#define SDW_NUM_DEV_ID_REGISTERS 6
/* frame shape defines */

/*
 * Note: The maximum row define in SoundWire spec 1.1 is 23. In order to
 * fill hole with 0, one more dummy entry is added
 */
#define SDW_FRAME_ROWS  24
#define SDW_FRAME_COLS  8
#define SDW_FRAME_ROW_COLS  (SDW_FRAME_ROWS * SDW_FRAME_COLS)

#define SDW_FRAME_CTRL_BITS  48
#define SDW_MAX_DEVICES   11
#define SDW_FW_MAX_DEVICES  16

#define SDW_MAX_PORTS   15
#define SDW_VALID_PORT_RANGE(n)  ((n) < SDW_MAX_PORTS && (n) >= 1)

#define SDW_MAX_LANES  8

enum {
 SDW_PORT_DIRN_SINK = 0,
 SDW_PORT_DIRN_SOURCE,
 SDW_PORT_DIRN_MAX,
};

/*
 * constants for flow control, ports and transport
 *
 * these are bit masks as devices can have multiple capabilities
 */

/*
 * flow modes for SDW port. These can be isochronous, tx controlled,
 * rx controlled or async
 */
#define SDW_PORT_FLOW_MODE_ISOCH 0
#define SDW_PORT_FLOW_MODE_TX_CNTRL BIT(0)
#define SDW_PORT_FLOW_MODE_RX_CNTRL BIT(1)
#define SDW_PORT_FLOW_MODE_ASYNC GENMASK(1, 0)

/* sample packaging for block. It can be per port or per channel */
#define SDW_BLOCK_PACKG_PER_PORT BIT(0)
#define SDW_BLOCK_PACKG_PER_CH  BIT(1)

/**
 * enum sdw_slave_status - Slave status
 * @SDW_SLAVE_UNATTACHED: Slave is not attached with the bus.
 * @SDW_SLAVE_ATTACHED: Slave is attached with bus.
 * @SDW_SLAVE_ALERT: Some alert condition on the Slave
 * @SDW_SLAVE_RESERVED: Reserved for future use
 */
enum sdw_slave_status {
 SDW_SLAVE_UNATTACHED = 0,
 SDW_SLAVE_ATTACHED = 1,
 SDW_SLAVE_ALERT = 2,
 SDW_SLAVE_RESERVED = 3,
};

/**
 * enum sdw_clk_stop_type: clock stop operations
 *
 * @SDW_CLK_PRE_PREPARE: pre clock stop prepare
 * @SDW_CLK_POST_PREPARE: post clock stop prepare
 * @SDW_CLK_PRE_DEPREPARE: pre clock stop de-prepare
 * @SDW_CLK_POST_DEPREPARE: post clock stop de-prepare
 */
enum sdw_clk_stop_type {
 SDW_CLK_PRE_PREPARE = 0,
 SDW_CLK_POST_PREPARE,
 SDW_CLK_PRE_DEPREPARE,
 SDW_CLK_POST_DEPREPARE,
};

/**
 * enum sdw_command_response - Command response as defined by SDW spec
 * @SDW_CMD_OK: cmd was successful
 * @SDW_CMD_IGNORED: cmd was ignored
 * @SDW_CMD_FAIL: cmd was NACKed
 * @SDW_CMD_TIMEOUT: cmd timedout
 * @SDW_CMD_FAIL_OTHER: cmd failed due to other reason than above
 *
 * NOTE: The enum is different than actual Spec as response in the Spec is
 * combination of ACK/NAK bits
 *
 * SDW_CMD_TIMEOUT/FAIL_OTHER is defined for SW use, not in spec
 */
enum sdw_command_response {
 SDW_CMD_OK = 0,
 SDW_CMD_IGNORED = 1,
 SDW_CMD_FAIL = 2,
 SDW_CMD_TIMEOUT = 3,
 SDW_CMD_FAIL_OTHER = 4,
};

/* block group count enum */
enum sdw_dpn_grouping {
 SDW_BLK_GRP_CNT_1 = 0,
 SDW_BLK_GRP_CNT_2 = 1,
 SDW_BLK_GRP_CNT_3 = 2,
 SDW_BLK_GRP_CNT_4 = 3,
};

/* block packing mode enum */
enum sdw_dpn_pkg_mode {
 SDW_BLK_PKG_PER_PORT = 0,
 SDW_BLK_PKG_PER_CHANNEL = 1
};

/**
 * enum sdw_stream_type: data stream type
 *
 * @SDW_STREAM_PCM: PCM data stream
 * @SDW_STREAM_PDM: PDM data stream
 * @SDW_STREAM_BPT: BPT data stream
 *
 * spec doesn't define this, but is used in implementation
 */
enum sdw_stream_type {
 SDW_STREAM_PCM = 0,
 SDW_STREAM_PDM = 1,
 SDW_STREAM_BPT = 2,
};

/**
 * enum sdw_data_direction: Data direction
 *
 * @SDW_DATA_DIR_RX: Data into Port
 * @SDW_DATA_DIR_TX: Data out of Port
 */
enum sdw_data_direction {
 SDW_DATA_DIR_RX = 0,
 SDW_DATA_DIR_TX = 1,
};

/**
 * enum sdw_port_data_mode: Data Port mode
 *
 * @SDW_PORT_DATA_MODE_NORMAL: Normal data mode where audio data is received
 * and transmitted.
 * @SDW_PORT_DATA_MODE_PRBS: Test mode which uses a PRBS generator to produce
 * a pseudo random data pattern that is transferred
 * @SDW_PORT_DATA_MODE_STATIC_0: Simple test mode which uses static value of
 * logic 0. The encoding will result in no signal transitions
 * @SDW_PORT_DATA_MODE_STATIC_1: Simple test mode which uses static value of
 * logic 1. The encoding will result in signal transitions at every bitslot
 * owned by this Port
 */
enum sdw_port_data_mode {
 SDW_PORT_DATA_MODE_NORMAL = 0,
 SDW_PORT_DATA_MODE_PRBS = 1,
 SDW_PORT_DATA_MODE_STATIC_0 = 2,
 SDW_PORT_DATA_MODE_STATIC_1 = 3,
};

/*
 * SDW properties, defined in MIPI DisCo spec v1.0
 */
enum sdw_clk_stop_reset_behave {
 SDW_CLK_STOP_KEEP_STATUS = 1,
};

/**
 * enum sdw_p15_behave - Slave Port 15 behaviour when the Master attempts a
 * read
 * @SDW_P15_READ_IGNORED: Read is ignored
 * @SDW_P15_CMD_OK: Command is ok
 */
enum sdw_p15_behave {
 SDW_P15_READ_IGNORED = 0,
 SDW_P15_CMD_OK = 1,
};

/**
 * enum sdw_dpn_type - Data port types
 * @SDW_DPN_FULL: Full Data Port is supported
 * @SDW_DPN_SIMPLE: Simplified Data Port as defined in spec.
 * DPN_SampleCtrl2, DPN_OffsetCtrl2, DPN_HCtrl and DPN_BlockCtrl3
 * are not implemented.
 * @SDW_DPN_REDUCED: Reduced Data Port as defined in spec.
 * DPN_SampleCtrl2, DPN_HCtrl are not implemented.
 */
enum sdw_dpn_type {
 SDW_DPN_FULL = 0,
 SDW_DPN_SIMPLE = 1,
 SDW_DPN_REDUCED = 2,
};

/**
 * enum sdw_clk_stop_mode - Clock Stop modes
 * @SDW_CLK_STOP_MODE0: Slave can continue operation seamlessly on clock
 * restart
 * @SDW_CLK_STOP_MODE1: Slave may have entered a deeper power-saving mode,
 * not capable of continuing operation seamlessly when the clock restarts
 */
enum sdw_clk_stop_mode {
 SDW_CLK_STOP_MODE0 = 0,
 SDW_CLK_STOP_MODE1 = 1,
};

/**
 * struct sdw_dp0_prop - DP0 properties
 * @words: wordlengths supported
 * @max_word: Maximum number of bits in a Payload Channel Sample, 1 to 64
 * (inclusive)
 * @min_word: Minimum number of bits in a Payload Channel Sample, 1 to 64
 * (inclusive)
 * @num_words: number of wordlengths supported
 * @ch_prep_timeout: Port-specific timeout value, in milliseconds
 * @BRA_flow_controlled: Slave implementation results in an OK_NotReady
 * response
 * @simple_ch_prep_sm: If channel prepare sequence is required
 * @imp_def_interrupts: If set, each bit corresponds to support for
 * implementation-defined interrupts
 * @num_lanes: array size of @lane_list
 * @lane_list: indicates which Lanes can be used by DP0
 *
 * The wordlengths are specified by Spec as max, min AND number of
 * discrete values, implementation can define based on the wordlengths they
 * support
 */
struct sdw_dp0_prop {
 u32 *words;
 u32 max_word;
 u32 min_word;
 u32 num_words;
 u32 ch_prep_timeout;
 bool BRA_flow_controlled;
 bool simple_ch_prep_sm;
 bool imp_def_interrupts;
 int num_lanes;
 u32 *lane_list;
};

/**
 * struct sdw_dpn_prop - Data Port DPn properties
 * @num: port number
 * @max_word: Maximum number of bits in a Payload Channel Sample, 1 to 64
 * (inclusive)
 * @min_word: Minimum number of bits in a Payload Channel Sample, 1 to 64
 * (inclusive)
 * @num_words: Number of discrete supported wordlengths
 * @words: Discrete supported wordlength
 * @type: Data port type. Full, Simplified or Reduced
 * @max_grouping: Maximum number of samples that can be grouped together for
 * a full data port
 * @ch_prep_timeout: Port-specific timeout value, in milliseconds
 * @imp_def_interrupts: If set, each bit corresponds to support for
 * implementation-defined interrupts
 * @max_ch: Maximum channels supported
 * @min_ch: Minimum channels supported
 * @num_channels: Number of discrete channels supported
 * @num_ch_combinations: Number of channel combinations supported
 * @channels: Discrete channels supported
 * @ch_combinations: Channel combinations supported
 * @lane_list: indicates which Lanes can be used by DPn
 * @num_lanes: array size of @lane_list
 * @modes: SDW mode supported
 * @max_async_buffer: Number of samples that this port can buffer in
 * asynchronous modes
 * @port_encoding: Payload Channel Sample encoding schemes supported
 * @block_pack_mode: Type of block port mode supported
 * @read_only_wordlength: Read Only wordlength field in DPN_BlockCtrl1 register
 * @simple_ch_prep_sm: If the port supports simplified channel prepare state
 * machine
 */
struct sdw_dpn_prop {
 u32 num;
 u32 max_word;
 u32 min_word;
 u32 num_words;
 u32 *words;
 enum sdw_dpn_type type;
 u32 max_grouping;
 u32 ch_prep_timeout;
 u32 imp_def_interrupts;
 u32 max_ch;
 u32 min_ch;
 u32 num_channels;
 u32 num_ch_combinations;
 u32 *channels;
 u32 *ch_combinations;
 u32 *lane_list;
 int num_lanes;
 u32 modes;
 u32 max_async_buffer;
 u32 port_encoding;
 bool block_pack_mode;
 bool read_only_wordlength;
 bool simple_ch_prep_sm;
};

/**
 * struct sdw_slave_prop - SoundWire Slave properties
 * @dp0_prop: Data Port 0 properties
 * @src_dpn_prop: Source Data Port N properties
 * @sink_dpn_prop: Sink Data Port N properties
 * @mipi_revision: Spec version of the implementation
 * @wake_capable: Wake-up events are supported
 * @test_mode_capable: If test mode is supported
 * @clk_stop_mode1: Clock-Stop Mode 1 is supported
 * @simple_clk_stop_capable: Simple clock mode is supported
 * @clk_stop_timeout: Worst-case latency of the Clock Stop Prepare State
 * Machine transitions, in milliseconds
 * @ch_prep_timeout: Worst-case latency of the Channel Prepare State Machine
 * transitions, in milliseconds
 * @reset_behave: Slave keeps the status of the SlaveStopClockPrepare
 * state machine (P=1 SCSP_SM) after exit from clock-stop mode1
 * @high_PHY_capable: Slave is HighPHY capable
 * @paging_support: Slave implements paging registers SCP_AddrPage1 and
 * SCP_AddrPage2
 * @bank_delay_support: Slave implements bank delay/bridge support registers
 * SCP_BankDelay and SCP_NextFrame
 * @lane_control_support: Slave supports lane control
 * @p15_behave: Slave behavior when the Master attempts a read to the Port15
 * alias
 * @master_count: Number of Masters present on this Slave
 * @source_ports: Bitmap identifying source ports
 * @sink_ports: Bitmap identifying sink ports
 * @quirks: bitmask identifying deltas from the MIPI specification
 * @sdca_interrupt_register_list: indicates which sets of SDCA interrupt status
 * and masks are supported
 * @commit_register_supported: is PCP_Commit register supported
 * @scp_int1_mask: SCP_INT1_MASK desired settings
 * @lane_maps: Lane mapping for the slave, only valid if lane_control_support is set
 * @clock_reg_supported: the Peripheral implements the clock base and scale
 * registers introduced with the SoundWire 1.2 specification. SDCA devices
 * do not need to set this boolean property as the registers are required.
 * @use_domain_irq: call actual IRQ handler on slave, as well as callback
 */
struct sdw_slave_prop {
 struct sdw_dp0_prop *dp0_prop;
 struct sdw_dpn_prop *src_dpn_prop;
 struct sdw_dpn_prop *sink_dpn_prop;
 u32 mipi_revision;
 bool wake_capable;
 bool test_mode_capable;
 bool clk_stop_mode1;
 bool simple_clk_stop_capable;
 u32 clk_stop_timeout;
 u32 ch_prep_timeout;
 enum sdw_clk_stop_reset_behave reset_behave;
 bool high_PHY_capable;
 bool paging_support;
 bool bank_delay_support;
 bool lane_control_support;
 enum sdw_p15_behave p15_behave;
 u32 master_count;
 u32 source_ports;
 u32 sink_ports;
 u32 quirks;
 u32 sdca_interrupt_register_list;
 u8 commit_register_supported;
 u8 scp_int1_mask;
 u8 lane_maps[SDW_MAX_LANES];
 bool clock_reg_supported;
 bool use_domain_irq;
};

#define SDW_SLAVE_QUIRKS_INVALID_INITIAL_PARITY BIT(0)

/**
 * struct sdw_master_prop - Master properties
 * @clk_gears: Clock gears supported
 * @clk_freq: Clock frequencies supported, in Hz
 * @quirks: bitmask identifying optional behavior beyond the scope of the MIPI specification
 * @revision: MIPI spec version of the implementation
 * @clk_stop_modes: Bitmap, bit N set when clock-stop-modeN supported
 * @max_clk_freq: Maximum Bus clock frequency, in Hz
 * @num_clk_gears: Number of clock gears supported
 * @num_clk_freq: Number of clock frequencies supported, in Hz
 * @default_frame_rate: Controller default Frame rate, in Hz
 * @default_row: Number of rows
 * @default_col: Number of columns
 * @dynamic_frame: Dynamic frame shape supported
 * @err_threshold: Number of times that software may retry sending a single
 * command
 * @mclk_freq: clock reference passed to SoundWire Master, in Hz.
 * @hw_disabled: if true, the Master is not functional, typically due to pin-mux
 */
struct sdw_master_prop {
 u32 *clk_gears;
 u32 *clk_freq;
 u64 quirks;
 u32 revision;
 u32 clk_stop_modes;
 u32 max_clk_freq;
 u32 num_clk_gears;
 u32 num_clk_freq;
 u32 default_frame_rate;
 u32 default_row;
 u32 default_col;
 u32 err_threshold;
 u32 mclk_freq;
 bool dynamic_frame;
 bool hw_disabled;
};

/* Definitions for Master quirks */

/*
 * In a number of platforms bus clashes are reported after a hardware
 * reset but without any explanations or evidence of a real problem.
 * The following quirk will discard all initial bus clash interrupts
 * but will leave the detection on should real bus clashes happen
 */
#define SDW_MASTER_QUIRKS_CLEAR_INITIAL_CLASH BIT(0)

/*
 * Some Slave devices have known issues with incorrect parity errors
 * reported after a hardware reset. However during integration unexplained
 * parity errors can be reported by Slave devices, possibly due to electrical
 * issues at the Master level.
 * The following quirk will discard all initial parity errors but will leave
 * the detection on should real parity errors happen.
 */
#define SDW_MASTER_QUIRKS_CLEAR_INITIAL_PARITY BIT(1)

int sdw_master_read_prop(struct sdw_bus *bus);
int sdw_slave_read_prop(struct sdw_slave *slave);
int sdw_slave_read_lane_mapping(struct sdw_slave *slave);

/*
 * SDW Slave Structures and APIs
 */

#define SDW_IGNORED_UNIQUE_ID 0xFF

/**
 * struct sdw_slave_id - Slave ID
 * @mfg_id: MIPI Manufacturer ID
 * @part_id: Device Part ID
 * @class_id: MIPI Class ID (defined starting with SoundWire 1.2 spec)
 * @unique_id: Device unique ID
 * @sdw_version: SDW version implemented
 *
 * The order of the IDs here does not follow the DisCo spec definitions
 */
struct sdw_slave_id {
 __u16 mfg_id;
 __u16 part_id;
 __u8 class_id;
 __u8 unique_id;
 __u8 sdw_version:4;
};

struct sdw_peripherals {
 int num_peripherals;
 struct sdw_slave *array[];
};

/*
 * Helper macros to extract the MIPI-defined IDs
 *
 * Spec definition
 *   Register  Bit Contents
 *   DevId_0 [7:4] 47:44 sdw_version
 *   DevId_0 [3:0] 43:40 unique_id
 *   DevId_1  39:32 mfg_id [15:8]
 *   DevId_2  31:24 mfg_id [7:0]
 *   DevId_3  23:16 part_id [15:8]
 *   DevId_4  15:08 part_id [7:0]
 *   DevId_5  07:00 class_id
 *
 * The MIPI DisCo for SoundWire defines in addition the link_id as bits 51:48
 */
#define SDW_DISCO_LINK_ID_MASK GENMASK_ULL(51, 48)
#define SDW_VERSION_MASK GENMASK_ULL(47, 44)
#define SDW_UNIQUE_ID_MASK GENMASK_ULL(43, 40)
#define SDW_MFG_ID_MASK  GENMASK_ULL(39, 24)
#define SDW_PART_ID_MASK GENMASK_ULL(23, 8)
#define SDW_CLASS_ID_MASK GENMASK_ULL(7, 0)

#define SDW_DISCO_LINK_ID(addr) FIELD_GET(SDW_DISCO_LINK_ID_MASK, addr)
#define SDW_VERSION(addr) FIELD_GET(SDW_VERSION_MASK, addr)
#define SDW_UNIQUE_ID(addr) FIELD_GET(SDW_UNIQUE_ID_MASK, addr)
#define SDW_MFG_ID(addr) FIELD_GET(SDW_MFG_ID_MASK, addr)
#define SDW_PART_ID(addr) FIELD_GET(SDW_PART_ID_MASK, addr)
#define SDW_CLASS_ID(addr) FIELD_GET(SDW_CLASS_ID_MASK, addr)

/**
 * struct sdw_slave_intr_status - Slave interrupt status
 * @sdca_cascade: set if the Slave device reports an SDCA interrupt
 * @control_port: control port status
 * @port: data port status
 */
struct sdw_slave_intr_status {
 bool sdca_cascade;
 u8 control_port;
 u8 port[15];
};

/**
 * sdw_reg_bank - SoundWire register banks
 * @SDW_BANK0: Soundwire register bank 0
 * @SDW_BANK1: Soundwire register bank 1
 */
enum sdw_reg_bank {
 SDW_BANK0,
 SDW_BANK1,
};

/**
 * struct sdw_prepare_ch: Prepare/De-prepare Data Port channel
 *
 * @num: Port number
 * @ch_mask: Active channel mask
 * @prepare: Prepare (true) /de-prepare (false) channel
 * @bank: Register bank, which bank Slave/Master driver should program for
 * implementation defined registers. This is always updated to next_bank
 * value read from bus params.
 *
 */
struct sdw_prepare_ch {
 unsigned int num;
 unsigned int ch_mask;
 bool prepare;
 unsigned int bank;
};

/**
 * enum sdw_port_prep_ops: Prepare operations for Data Port
 *
 * @SDW_OPS_PORT_PRE_PREP: Pre prepare operation for the Port
 * @SDW_OPS_PORT_PRE_DEPREP: Pre deprepare operation for the Port
 * @SDW_OPS_PORT_POST_PREP: Post prepare operation for the Port
 * @SDW_OPS_PORT_POST_DEPREP: Post deprepare operation for the Port
 */
enum sdw_port_prep_ops {
 SDW_OPS_PORT_PRE_PREP = 0,
 SDW_OPS_PORT_PRE_DEPREP,
 SDW_OPS_PORT_POST_PREP,
 SDW_OPS_PORT_POST_DEPREP,
};

/**
 * struct sdw_bus_params: Structure holding bus configuration
 *
 * @curr_bank: Current bank in use (BANK0/BANK1)
 * @next_bank: Next bank to use (BANK0/BANK1). next_bank will always be
 * set to !curr_bank
 * @max_dr_freq: Maximum double rate clock frequency supported, in Hz
 * @curr_dr_freq: Current double rate clock frequency, in Hz
 * @bandwidth: Current bandwidth
 * @col: Active columns
 * @row: Active rows
 * @s_data_mode: NORMAL, STATIC or PRBS mode for all Slave ports
 * @m_data_mode: NORMAL, STATIC or PRBS mode for all Master ports. The value
 * should be the same to detect transmission issues, but can be different to
 * test the interrupt reports
 */
struct sdw_bus_params {
 enum sdw_reg_bank curr_bank;
 enum sdw_reg_bank next_bank;
 unsigned int max_dr_freq;
 unsigned int curr_dr_freq;
 unsigned int bandwidth;
 unsigned int col;
 unsigned int row;
 int s_data_mode;
 int m_data_mode;
};

/**
 * struct sdw_slave_ops: Slave driver callback ops
 *
 * @read_prop: Read Slave properties
 * @interrupt_callback: Device interrupt notification (invoked in thread
 * context)
 * @update_status: Update Slave status
 * @bus_config: Update the bus config for Slave
 * @port_prep: Prepare the port with parameters
 * @clk_stop: handle imp-def sequences before and after prepare and de-prepare
 */
struct sdw_slave_ops {
 int (*read_prop)(struct sdw_slave *sdw);
 int (*interrupt_callback)(struct sdw_slave *slave,
      struct sdw_slave_intr_status *status);
 int (*update_status)(struct sdw_slave *slave,
        enum sdw_slave_status status);
 int (*bus_config)(struct sdw_slave *slave,
     struct sdw_bus_params *params);
 int (*port_prep)(struct sdw_slave *slave,
    struct sdw_prepare_ch *prepare_ch,
    enum sdw_port_prep_ops pre_ops);
 int (*clk_stop)(struct sdw_slave *slave,
   enum sdw_clk_stop_mode mode,
   enum sdw_clk_stop_type type);
};

/**
 * struct sdw_slave - SoundWire Slave
 * @id: MIPI device ID
 * @dev: Linux device
 * @index: internal ID for this slave
 * @irq: IRQ number
 * @status: Status reported by the Slave
 * @bus: Bus handle
 * @prop: Slave properties
 * @debugfs: Slave debugfs
 * @node: node for bus list
 * @port_ready: Port ready completion flag for each Slave port
 * @m_port_map: static Master port map for each Slave port
 * @dev_num: Current Device Number, values can be 0 or dev_num_sticky
 * @dev_num_sticky: one-time static Device Number assigned by Bus
 * @probed: boolean tracking driver state
 * @enumeration_complete: completion utility to control potential races
 * on startup between device enumeration and read/write access to the
 * Slave device
 * @initialization_complete: completion utility to control potential races
 * on startup between device enumeration and settings being restored
 * @unattach_request: mask field to keep track why the Slave re-attached and
 * was re-initialized. This is useful to deal with potential race conditions
 * between the Master suspending and the codec resuming, and make sure that
 * when the Master triggered a reset the Slave is properly enumerated and
 * initialized
 * @first_interrupt_done: status flag tracking if the interrupt handling
 * for a Slave happens for the first time after enumeration
 * @is_mockup_device: status flag used to squelch errors in the command/control
 * protocol for SoundWire mockup devices
 * @sdw_dev_lock: mutex used to protect callbacks/remove races
 * @sdca_data: structure containing all device data for SDCA helpers
 */
struct sdw_slave {
 struct sdw_slave_id id;
 struct device dev;
 int index;
 int irq;
 enum sdw_slave_status status;
 struct sdw_bus *bus;
 struct sdw_slave_prop prop;
#ifdef CONFIG_DEBUG_FS
 struct dentry *debugfs;
#endif
 struct list_head node;
 struct completion port_ready[SDW_MAX_PORTS];
 unsigned int m_port_map[SDW_MAX_PORTS];
 u16 dev_num;
 u16 dev_num_sticky;
 bool probed;
 struct completion enumeration_complete;
 struct completion initialization_complete;
 u32 unattach_request;
 bool first_interrupt_done;
 bool is_mockup_device;
 struct mutex sdw_dev_lock; /* protect callbacks/remove races */
 struct sdca_device_data sdca_data;
};

#define dev_to_sdw_dev(_dev) container_of(_dev, struct sdw_slave, dev)

/**
 * struct sdw_master_device - SoundWire 'Master Device' representation
 * @dev: Linux device for this Master
 * @bus: Bus handle shortcut
 */
struct sdw_master_device {
 struct device dev;
 struct sdw_bus *bus;
};

#define dev_to_sdw_master_device(d) \
 container_of(d, struct sdw_master_device, dev)

struct sdw_driver {
 int (*probe)(struct sdw_slave *sdw, const struct sdw_device_id *id);
 int (*remove)(struct sdw_slave *sdw);
 void (*shutdown)(struct sdw_slave *sdw);

 const struct sdw_device_id *id_table;
 const struct sdw_slave_ops *ops;

 struct device_driver driver;
};

#define SDW_SLAVE_ENTRY_EXT(_mfg_id, _part_id, _version, _c_id, _drv_data) \
 { .mfg_id = (_mfg_id), .part_id = (_part_id),  \
   .sdw_version = (_version), .class_id = (_c_id), \
   .driver_data = (unsigned long)(_drv_data) }

#define SDW_SLAVE_ENTRY(_mfg_id, _part_id, _drv_data) \
 SDW_SLAVE_ENTRY_EXT((_mfg_id), (_part_id), 0, 0, (_drv_data))

int sdw_handle_slave_status(struct sdw_bus *bus,
       enum sdw_slave_status status[]);

/*
 * SDW master structures and APIs
 */

/**
 * struct sdw_port_params: Data Port parameters
 *
 * @num: Port number
 * @bps: Word length of the Port
 * @flow_mode: Port Data flow mode
 * @data_mode: Test modes or normal mode
 *
 * This is used to program the Data Port based on Data Port stream
 * parameters.
 */
struct sdw_port_params {
 unsigned int num;
 unsigned int bps;
 unsigned int flow_mode;
 unsigned int data_mode;
};

/**
 * struct sdw_transport_params: Data Port Transport Parameters
 *
 * @blk_grp_ctrl_valid: Port implements block group control
 * @num: Port number
 * @blk_grp_ctrl: Block group control value
 * @sample_interval: Sample interval
 * @offset1: Blockoffset of the payload data
 * @offset2: Blockoffset of the payload data
 * @hstart: Horizontal start of the payload data
 * @hstop: Horizontal stop of the payload data
 * @blk_pkg_mode: Block per channel or block per port
 * @lane_ctrl: Data lane Port uses for Data transfer. Currently only single
 * data lane is supported in bus
 *
 * This is used to program the Data Port based on Data Port transport
 * parameters. All these parameters are banked and can be modified
 * during a bank switch without any artifacts in audio stream.
 */
struct sdw_transport_params {
 bool blk_grp_ctrl_valid;
 unsigned int port_num;
 unsigned int blk_grp_ctrl;
 unsigned int sample_interval;
 unsigned int offset1;
 unsigned int offset2;
 unsigned int hstart;
 unsigned int hstop;
 unsigned int blk_pkg_mode;
 unsigned int lane_ctrl;
};

/**
 * struct sdw_enable_ch: Enable/disable Data Port channel
 *
 * @num: Port number
 * @ch_mask: Active channel mask
 * @enable: Enable (true) /disable (false) channel
 */
struct sdw_enable_ch {
 unsigned int port_num;
 unsigned int ch_mask;
 bool enable;
};

/**
 * struct sdw_master_port_ops: Callback functions from bus to Master
 * driver to set Master Data ports.
 *
 * @dpn_set_port_params: Set the Port parameters for the Master Port.
 * Mandatory callback
 * @dpn_set_port_transport_params: Set transport parameters for the Master
 * Port. Mandatory callback
 * @dpn_port_prep: Port prepare operations for the Master Data Port.
 * @dpn_port_enable_ch: Enable the channels of Master Port.
 */
struct sdw_master_port_ops {
 int (*dpn_set_port_params)(struct sdw_bus *bus,
       struct sdw_port_params *port_params,
       unsigned int bank);
 int (*dpn_set_port_transport_params)(struct sdw_bus *bus,
          struct sdw_transport_params *transport_params,
          enum sdw_reg_bank bank);
 int (*dpn_port_prep)(struct sdw_bus *bus, struct sdw_prepare_ch *prepare_ch);
 int (*dpn_port_enable_ch)(struct sdw_bus *bus,
      struct sdw_enable_ch *enable_ch, unsigned int bank);
};

struct sdw_msg;

/**
 * struct sdw_defer - SDW deferred message
 * @complete: message completion
 * @msg: SDW message
 * @length: message length
 */
struct sdw_defer {
 struct sdw_msg *msg;
 int length;
 struct completion complete;
};

/*
 * Add a practical limit to BPT transfer sizes. BPT is typically used
 * to transfer firmware, and larger firmware transfers will increase
 * the cold latency beyond typical OS or user requirements.
 */
#define SDW_BPT_MSG_MAX_BYTES  (1024 * 1024)

struct sdw_bpt_msg;

/**
 * struct sdw_master_ops - Master driver ops
 * @read_prop: Read Master properties
 * @override_adr: Override value read from firmware (quirk for buggy firmware)
 * @xfer_msg: Transfer message callback
 * @xfer_msg_defer: Defer version of transfer message callback. The message is handled with the
 * bus struct @sdw_defer
 * @set_bus_conf: Set the bus configuration
 * @pre_bank_switch: Callback for pre bank switch
 * @post_bank_switch: Callback for post bank switch
 * @read_ping_status: Read status from PING frames, reported with two bits per Device.
 * Bits 31:24 are reserved.
 * @get_device_num: Callback for vendor-specific device_number allocation
 * @put_device_num: Callback for vendor-specific device_number release
 * @new_peripheral_assigned: Callback to handle enumeration of new peripheral.
 * @bpt_send_async: reserve resources for BPT stream and send message
 * using BTP protocol
 * @bpt_wait: wait for message completion using BTP protocol
 * and release resources
 */
struct sdw_master_ops {
 int (*read_prop)(struct sdw_bus *bus);
 u64 (*override_adr)(struct sdw_bus *bus, u64 addr);
 enum sdw_command_response (*xfer_msg)(struct sdw_bus *bus, struct sdw_msg *msg);
 enum sdw_command_response (*xfer_msg_defer)(struct sdw_bus *bus);
 int (*set_bus_conf)(struct sdw_bus *bus,
       struct sdw_bus_params *params);
 int (*pre_bank_switch)(struct sdw_bus *bus);
 int (*post_bank_switch)(struct sdw_bus *bus);
 u32 (*read_ping_status)(struct sdw_bus *bus);
 int (*get_device_num)(struct sdw_bus *bus, struct sdw_slave *slave);
 void (*put_device_num)(struct sdw_bus *bus, struct sdw_slave *slave);
 void (*new_peripheral_assigned)(struct sdw_bus *bus,
     struct sdw_slave *slave,
     int dev_num);
 int (*bpt_send_async)(struct sdw_bus *bus, struct sdw_slave *slave,
         struct sdw_bpt_msg *msg);
 int (*bpt_wait)(struct sdw_bus *bus, struct sdw_slave *slave, struct sdw_bpt_msg *msg);
};

int sdw_bus_master_add(struct sdw_bus *bus, struct device *parent,
         struct fwnode_handle *fwnode);
void sdw_bus_master_delete(struct sdw_bus *bus);

void sdw_show_ping_status(struct sdw_bus *bus, bool sync_delay);

/**
 * sdw_port_config: Master or Slave Port configuration
 *
 * @num: Port number
 * @ch_mask: channels mask for port
 */
struct sdw_port_config {
 unsigned int num;
 unsigned int ch_mask;
};

/**
 * sdw_stream_config: Master or Slave stream configuration
 *
 * @frame_rate: Audio frame rate of the stream, in Hz
 * @ch_count: Channel count of the stream
 * @bps: Number of bits per audio sample
 * @direction: Data direction
 * @type: Stream type PCM, PDM or BPT
 */
struct sdw_stream_config {
 unsigned int frame_rate;
 unsigned int ch_count;
 unsigned int bps;
 enum sdw_data_direction direction;
 enum sdw_stream_type type;
};

/**
 * sdw_stream_state: Stream states
 *
 * @SDW_STREAM_ALLOCATED: New stream allocated.
 * @SDW_STREAM_CONFIGURED: Stream configured
 * @SDW_STREAM_PREPARED: Stream prepared
 * @SDW_STREAM_ENABLED: Stream enabled
 * @SDW_STREAM_DISABLED: Stream disabled
 * @SDW_STREAM_DEPREPARED: Stream de-prepared
 * @SDW_STREAM_RELEASED: Stream released
 */
enum sdw_stream_state {
 SDW_STREAM_ALLOCATED = 0,
 SDW_STREAM_CONFIGURED = 1,
 SDW_STREAM_PREPARED = 2,
 SDW_STREAM_ENABLED = 3,
 SDW_STREAM_DISABLED = 4,
 SDW_STREAM_DEPREPARED = 5,
 SDW_STREAM_RELEASED = 6,
};

/**
 * sdw_stream_params: Stream parameters
 *
 * @rate: Sampling frequency, in Hz
 * @ch_count: Number of channels
 * @bps: bits per channel sample
 */
struct sdw_stream_params {
 unsigned int rate;
 unsigned int ch_count;
 unsigned int bps;
};

/**
 * sdw_stream_runtime: Runtime stream parameters
 *
 * @name: SoundWire stream name
 * @params: Stream parameters
 * @state: Current state of the stream
 * @type: Stream type PCM, PDM or BPT
 * @m_rt_count: Count of Master runtime(s) in this stream
 * @master_list: List of Master runtime(s) in this stream.
 * master_list can contain only one m_rt per Master instance
 * for a stream
 */
struct sdw_stream_runtime {
 const char *name;
 struct sdw_stream_params params;
 enum sdw_stream_state state;
 enum sdw_stream_type type;
 int m_rt_count;
 struct list_head master_list;
};

/**
 * struct sdw_bus - SoundWire bus
 * @dev: Shortcut to &bus->md->dev to avoid changing the entire code.
 * @md: Master device
 * @bus_lock_key: bus lock key associated to @bus_lock
 * @bus_lock: bus lock
 * @slave_ida: IDA for allocating internal slave IDs
 * @slaves: list of Slaves on this bus
 * @msg_lock_key: message lock key associated to @msg_lock
 * @msg_lock: message lock
 * @m_rt_list: List of Master instance of all stream(s) running on Bus. This
 * is used to compute and program bus bandwidth, clock, frame shape,
 * transport and port parameters
 * @defer_msg: Defer message
 * @params: Current bus parameters
 * @stream_refcount: number of streams currently using this bus
 * @btp_stream_refcount: number of BTP streams currently using this bus (should
 * be zero or one, multiple streams per link is not supported).
 * @bpt_stream: pointer stored to handle BTP streams.
 * @ops: Master callback ops
 * @port_ops: Master port callback ops
 * @prop: Master properties
 * @vendor_specific_prop: pointer to non-standard properties
 * @hw_sync_min_links: Number of links used by a stream above which
 * hardware-based synchronization is required. This value is only
 * meaningful if multi_link is set. If set to 1, hardware-based
 * synchronization will be used even if a stream only uses a single
 * SoundWire segment.
 * @controller_id: system-unique controller ID. If set to -1, the bus @id will be used.
 * @link_id: Link id number, can be 0 to N, unique for each Controller
 * @id: bus system-wide unique id
 * @compute_params: points to Bus resource management implementation
 * @assigned: Bitmap for Slave device numbers.
 * Bit set implies used number, bit clear implies unused number.
 * @clk_stop_timeout: Clock stop timeout computed
 * @bank_switch_timeout: Bank switch timeout computed
 * @domain: IRQ domain
 * @irq_chip: IRQ chip
 * @debugfs: Bus debugfs (optional)
 * @multi_link: Store bus property that indicates if multi links
 * are supported. This flag is populated by drivers after reading
 * appropriate firmware (ACPI/DT).
 * @lane_used_bandwidth: how much bandwidth in bits per second is used by each lane
 */
struct sdw_bus {
 struct device *dev;
 struct sdw_master_device *md;
 struct lock_class_key bus_lock_key;
 struct mutex bus_lock;
 struct ida slave_ida;
 struct list_head slaves;
 struct lock_class_key msg_lock_key;
 struct mutex msg_lock;
 struct list_head m_rt_list;
 struct sdw_defer defer_msg;
 struct sdw_bus_params params;
 int stream_refcount;
 int bpt_stream_refcount;
 struct sdw_stream_runtime *bpt_stream;
 const struct sdw_master_ops *ops;
 const struct sdw_master_port_ops *port_ops;
 struct sdw_master_prop prop;
 void *vendor_specific_prop;
 int hw_sync_min_links;
 int controller_id;
 unsigned int link_id;
 int id;
 int (*compute_params)(struct sdw_bus *bus, struct sdw_stream_runtime *stream);
 DECLARE_BITMAP(assigned, SDW_MAX_DEVICES);
 unsigned int clk_stop_timeout;
 u32 bank_switch_timeout;
 struct irq_chip irq_chip;
 struct irq_domain *domain;
#ifdef CONFIG_DEBUG_FS
 struct dentry *debugfs;
#endif
 bool multi_link;
 unsigned int lane_used_bandwidth[SDW_MAX_LANES];
};

struct sdw_stream_runtime *sdw_alloc_stream(const char *stream_name, enum sdw_stream_type type);
void sdw_release_stream(struct sdw_stream_runtime *stream);

int sdw_compute_params(struct sdw_bus *bus, struct sdw_stream_runtime *stream);

int sdw_stream_add_master(struct sdw_bus *bus,
     struct sdw_stream_config *stream_config,
     const struct sdw_port_config *port_config,
     unsigned int num_ports,
     struct sdw_stream_runtime *stream);
int sdw_stream_remove_master(struct sdw_bus *bus,
        struct sdw_stream_runtime *stream);
int sdw_startup_stream(void *sdw_substream);
int sdw_prepare_stream(struct sdw_stream_runtime *stream);
int sdw_enable_stream(struct sdw_stream_runtime *stream);
int sdw_disable_stream(struct sdw_stream_runtime *stream);
int sdw_deprepare_stream(struct sdw_stream_runtime *stream);
void sdw_shutdown_stream(void *sdw_substream);
int sdw_bus_prep_clk_stop(struct sdw_bus *bus);
int sdw_bus_clk_stop(struct sdw_bus *bus);
int sdw_bus_exit_clk_stop(struct sdw_bus *bus);

int sdw_compare_devid(struct sdw_slave *slave, struct sdw_slave_id id);
void sdw_extract_slave_id(struct sdw_bus *bus, u64 addr, struct sdw_slave_id *id);
bool is_clock_scaling_supported_by_slave(struct sdw_slave *slave);

int sdw_bpt_send_async(struct sdw_bus *bus, struct sdw_slave *slave, struct sdw_bpt_msg *msg);
int sdw_bpt_wait(struct sdw_bus *bus, struct sdw_slave *slave, struct sdw_bpt_msg *msg);
int sdw_bpt_send_sync(struct sdw_bus *bus, struct sdw_slave *slave, struct sdw_bpt_msg *msg);

#if IS_ENABLED(CONFIG_SOUNDWIRE)

int sdw_stream_add_slave(struct sdw_slave *slave,
    struct sdw_stream_config *stream_config,
    const struct sdw_port_config *port_config,
    unsigned int num_ports,
    struct sdw_stream_runtime *stream);
int sdw_stream_remove_slave(struct sdw_slave *slave,
       struct sdw_stream_runtime *stream);

int sdw_slave_get_scale_index(struct sdw_slave *slave, u8 *base);

/* messaging and data APIs */
int sdw_read(struct sdw_slave *slave, u32 addr);
int sdw_write(struct sdw_slave *slave, u32 addr, u8 value);
int sdw_write_no_pm(struct sdw_slave *slave, u32 addr, u8 value);
int sdw_read_no_pm(struct sdw_slave *slave, u32 addr);
int sdw_nread(struct sdw_slave *slave, u32 addr, size_t count, u8 *val);
int sdw_nread_no_pm(struct sdw_slave *slave, u32 addr, size_t count, u8 *val);
int sdw_nwrite(struct sdw_slave *slave, u32 addr, size_t count, const u8 *val);
int sdw_nwrite_no_pm(struct sdw_slave *slave, u32 addr, size_t count, const u8 *val);
int sdw_update(struct sdw_slave *slave, u32 addr, u8 mask, u8 val);
int sdw_update_no_pm(struct sdw_slave *slave, u32 addr, u8 mask, u8 val);

#else

static inline int sdw_stream_add_slave(struct sdw_slave *slave,
           struct sdw_stream_config *stream_config,
           const struct sdw_port_config *port_config,
           unsigned int num_ports,
           struct sdw_stream_runtime *stream)
{
 WARN_ONCE(1, "SoundWire API is disabled");
 return -EINVAL;
}

static inline int sdw_stream_remove_slave(struct sdw_slave *slave,
       struct sdw_stream_runtime *stream)
{
 WARN_ONCE(1, "SoundWire API is disabled");
 return -EINVAL;
}

/* messaging and data APIs */
static inline int sdw_read(struct sdw_slave *slave, u32 addr)
{
 WARN_ONCE(1, "SoundWire API is disabled");
 return -EINVAL;
}

static inline int sdw_write(struct sdw_slave *slave, u32 addr, u8 value)
{
 WARN_ONCE(1, "SoundWire API is disabled");
 return -EINVAL;
}

static inline int sdw_write_no_pm(struct sdw_slave *slave, u32 addr, u8 value)
{
 WARN_ONCE(1, "SoundWire API is disabled");
 return -EINVAL;
}

static inline int sdw_read_no_pm(struct sdw_slave *slave, u32 addr)
{
 WARN_ONCE(1, "SoundWire API is disabled");
 return -EINVAL;
}

static inline int sdw_nread(struct sdw_slave *slave, u32 addr, size_t count, u8 *val)
{
 WARN_ONCE(1, "SoundWire API is disabled");
 return -EINVAL;
}

static inline int sdw_nread_no_pm(struct sdw_slave *slave, u32 addr, size_t count, u8 *val)
{
 WARN_ONCE(1, "SoundWire API is disabled");
 return -EINVAL;
}

static inline int sdw_nwrite(struct sdw_slave *slave, u32 addr, size_t count, const u8 *val)
{
 WARN_ONCE(1, "SoundWire API is disabled");
 return -EINVAL;
}

static inline int sdw_nwrite_no_pm(struct sdw_slave *slave, u32 addr, size_t count, const u8 *val)
{
 WARN_ONCE(1, "SoundWire API is disabled");
 return -EINVAL;
}

static inline int sdw_update(struct sdw_slave *slave, u32 addr, u8 mask, u8 val)
{
 WARN_ONCE(1, "SoundWire API is disabled");
 return -EINVAL;
}

static inline int sdw_update_no_pm(struct sdw_slave *slave, u32 addr, u8 mask, u8 val)
{
 WARN_ONCE(1, "SoundWire API is disabled");
 return -EINVAL;
}

#endif /* CONFIG_SOUNDWIRE */

#endif /* __SOUNDWIRE_H */