[mirror_ubuntu-jammy-kernel.git] / Documentation / devicetree / bindings / ata / ahci-ceva.txt

Binding for CEVA AHCI SATA Controller

Required properties:
  - reg: Physical base address and size of the controller's register area.
  - compatible: Compatibility string. Must be 'ceva,ahci-1v84'.
  - clocks: Input clock specifier. Refer to common clock bindings.
  - interrupts: Interrupt specifier. Refer to interrupt binding.
  - ceva,p0-cominit-params: OOB timing value for COMINIT parameter for port 0.
  - ceva,p1-cominit-params: OOB timing value for COMINIT parameter for port 1.
			The fields for the above parameter must be as shown below:
			ceva,pN-cominit-params = /bits/ 8 <CIBGMN CIBGMX CIBGN CINMP>;
			CINMP : COMINIT Negate Minimum Period.
			CIBGN : COMINIT Burst Gap Nominal.
			CIBGMX: COMINIT Burst Gap Maximum.
			CIBGMN: COMINIT Burst Gap Minimum.
  - ceva,p0-comwake-params: OOB timing value for COMWAKE parameter for port 0.
  - ceva,p1-comwake-params: OOB timing value for COMWAKE parameter for port 1.
			The fields for the above parameter must be as shown below:
			ceva,pN-comwake-params = /bits/ 8 <CWBGMN CWBGMX CWBGN CWNMP>;
			CWBGMN: COMWAKE Burst Gap Minimum.
			CWBGMX: COMWAKE Burst Gap Maximum.
			CWBGN: COMWAKE Burst Gap Nominal.
			CWNMP: COMWAKE Negate Minimum Period.
  - ceva,p0-burst-params: Burst timing value for COM parameter for port 0.
  - ceva,p1-burst-params: Burst timing value for COM parameter for port 1.
			The fields for the above parameter must be as shown below:
			ceva,pN-burst-params = /bits/ 8 <BMX BNM SFD PTST>;
			BMX: COM Burst Maximum.
			BNM: COM Burst Nominal.
			SFD: Signal Failure Detection value.
			PTST: Partial to Slumber timer value.
  - ceva,p0-retry-params: Retry interval timing value for port 0.
  - ceva,p1-retry-params: Retry interval timing value for port 1.
			The fields for the above parameter must be as shown below:
			ceva,pN-retry-params = /bits/ 16 <RIT RCT>;
			RIT:  Retry Interval Timer.
			RCT:  Rate Change Timer.

Optional properties:
  - ceva,broken-gen2: limit to gen1 speed instead of gen2.
  - phys: phandle for the PHY device
  - resets: phandle to the reset controller for the SATA IP

Examples:
	ahci@fd0c0000 {
		compatible = "ceva,ahci-1v84";
		reg = <0xfd0c0000 0x200>;
		interrupt-parent = <&gic>;
		interrupts = <0 133 4>;
		clocks = <&clkc SATA_CLK_ID>;
		ceva,p0-cominit-params = /bits/ 8 <0x0F 0x25 0x18 0x29>;
		ceva,p0-comwake-params = /bits/ 8 <0x04 0x0B 0x08 0x0F>;
		ceva,p0-burst-params = /bits/ 8 <0x0A 0x08 0x4A 0x06>;
		ceva,p0-retry-params = /bits/ 16 <0x0216 0x7F06>;

		ceva,p1-cominit-params = /bits/ 8 <0x0F 0x25 0x18 0x29>;
		ceva,p1-comwake-params = /bits/ 8 <0x04 0x0B 0x08 0x0F>;
		ceva,p1-burst-params = /bits/ 8 <0x0A 0x08 0x4A 0x06>;
		ceva,p1-retry-params = /bits/ 16 <0x0216 0x7F06>;
		ceva,broken-gen2;
		phys = <&psgtr 1 PHY_TYPE_SATA 1 1>;
		resets = <&zynqmp_reset ZYNQMP_RESET_SATA>;
	};
Commit	Line	Data
03a740fb SG	1	Binding for CEVA AHCI SATA Controller
	2
	3	Required properties:
	4	- reg: Physical base address and size of the controller's register area.
	5	- compatible: Compatibility string. Must be 'ceva,ahci-1v84'.
	6	- clocks: Input clock specifier. Refer to common clock bindings.
	7	- interrupts: Interrupt specifier. Refer to interrupt binding.
9053f4b9 AKV	8	- ceva,p0-cominit-params: OOB timing value for COMINIT parameter for port 0.
	9	- ceva,p1-cominit-params: OOB timing value for COMINIT parameter for port 1.
	10	The fields for the above parameter must be as shown below:
	11	ceva,pN-cominit-params = /bits/ 8 <CIBGMN CIBGMX CIBGN CINMP>;
	12	CINMP : COMINIT Negate Minimum Period.
	13	CIBGN : COMINIT Burst Gap Nominal.
	14	CIBGMX: COMINIT Burst Gap Maximum.
	15	CIBGMN: COMINIT Burst Gap Minimum.
	16	- ceva,p0-comwake-params: OOB timing value for COMWAKE parameter for port 0.
	17	- ceva,p1-comwake-params: OOB timing value for COMWAKE parameter for port 1.
	18	The fields for the above parameter must be as shown below:
	19	ceva,pN-comwake-params = /bits/ 8 <CWBGMN CWBGMX CWBGN CWNMP>;
	20	CWBGMN: COMWAKE Burst Gap Minimum.
	21	CWBGMX: COMWAKE Burst Gap Maximum.
	22	CWBGN: COMWAKE Burst Gap Nominal.
	23	CWNMP: COMWAKE Negate Minimum Period.
	24	- ceva,p0-burst-params: Burst timing value for COM parameter for port 0.
	25	- ceva,p1-burst-params: Burst timing value for COM parameter for port 1.
	26	The fields for the above parameter must be as shown below:
	27	ceva,pN-burst-params = /bits/ 8 <BMX BNM SFD PTST>;
	28	BMX: COM Burst Maximum.
	29	BNM: COM Burst Nominal.
	30	SFD: Signal Failure Detection value.
	31	PTST: Partial to Slumber timer value.
	32	- ceva,p0-retry-params: Retry interval timing value for port 0.
	33	- ceva,p1-retry-params: Retry interval timing value for port 1.
	34	The fields for the above parameter must be as shown below:
	35	ceva,pN-retry-params = /bits/ 16 <RIT RCT>;
	36	RIT: Retry Interval Timer.
	37	RCT: Rate Change Timer.
03a740fb SG	38
	39	Optional properties:
	40	- ceva,broken-gen2: limit to gen1 speed instead of gen2.
3c0198c8 PM	41	- phys: phandle for the PHY device
3c0198c8 PM	42	- resets: phandle to the reset controller for the SATA IP
03a740fb SG	43
	44	Examples:
	45	ahci@fd0c0000 {
	46	compatible = "ceva,ahci-1v84";
	47	reg = <0xfd0c0000 0x200>;
	48	interrupt-parent = <&gic>;
	49	interrupts = <0 133 4>;
	50	clocks = <&clkc SATA_CLK_ID>;
9053f4b9 AKV	51	ceva,p0-cominit-params = /bits/ 8 <0x0F 0x25 0x18 0x29>;
	52	ceva,p0-comwake-params = /bits/ 8 <0x04 0x0B 0x08 0x0F>;
	53	ceva,p0-burst-params = /bits/ 8 <0x0A 0x08 0x4A 0x06>;
	54	ceva,p0-retry-params = /bits/ 16 <0x0216 0x7F06>;
	55
	56	ceva,p1-cominit-params = /bits/ 8 <0x0F 0x25 0x18 0x29>;
	57	ceva,p1-comwake-params = /bits/ 8 <0x04 0x0B 0x08 0x0F>;
	58	ceva,p1-burst-params = /bits/ 8 <0x0A 0x08 0x4A 0x06>;
	59	ceva,p1-retry-params = /bits/ 16 <0x0216 0x7F06>;
03a740fb	60	ceva,broken-gen2;
3c0198c8 PM	61	phys = <&psgtr 1 PHY_TYPE_SATA 1 1>;
3c0198c8 PM	62	resets = <&zynqmp_reset ZYNQMP_RESET_SATA>;
03a740fb	63	};