Lines Matching +full:resource +full:- +full:id

1 .\" Copyright (c) 2015-2016 Landon Fuller <landonf@FreeBSD.org>
38 .Ss Bus Resource Functions
392 .Bd -literal
398 .Bd -literal
406 .Bd -literal
414 .Bd -literal
417 .Bd -literal
427 .Bd -literal
435 .Bd -literal
442 .Bd -literal
512 .Bd -literal
568 .Bd -literal
609 .Bd -literal
635 .Bd -literal
683 .Bd -literal
690 on-chip interconnects and IP cores found in Broadcom Home Networking Division
694 host-connected chipsets based on a common library of Broadcom IP cores,
695 connected via one of two on-chip backplane (hardware bus) architectures.
701 device-specific CSRs, and SSB-specific per-core device management
707 The IP cores used in earlier SSB-based devices were adapted for compatibility
710 cores providing per-core device management functions in place of the SSB
711 per-core management registers.
713 When BHND hardware is used as a host-connected peripheral (e.g., in a PCI Wi-Fi
714 card), the on-chip peripheral controller core is configured to operate as
716 .Bl -dash -offset indent
723 These address regions may be used as a target for the on-chip DMA engine.
726 bridge to host interrupts (e.g., PCI INTx/MSI/MSI-X).
737 .Ss "Bus Resource Functions"
739 .Vt "struct resource"
744 bridged chipsets, may require on-demand remapping of address windows
748 drivers that, on host-connected peripherals, must share a small set of register
753 .Vt struct resource
758 function activates a previously allocated resource.
761 .Bl -tag -width indent
763 The device holding ownership of the allocated resource.
765 The type of the resource.
767 The bus-specific handle that identifies the resource being activated.
769 A pointer to the resource returned by
775 function allocates a resource from a device's parent
780 .Bl -tag -width indent
782 The device requesting resource ownership.
784 The type of resource to allocate.
789 The bus-specific handle identifying the resource being allocated.
791 The start address of the resource.
793 The end address of the resource.
795 The size of the resource.
797 The flags for the resource to be allocated.
803 To request that the bus supply the resource's default
820 using the resource's default
828 .Bl -tag -width indent
830 The device requesting resource ownership.
832 The type of resource to allocate.
837 The bus-specific handle identifying the resource being allocated.
839 The flags for the resource to be allocated.
847 function allocates resources defined in resource specification from a device's
853 .Bl -tag -width indent
857 A standard bus resource specification.
859 this will be updated with the allocated resource identifiers.
869 function deactivates a resource previously activated by.
872 .Bl -tag -width indent
874 The device holding ownership of the activated resource.
876 The type of the resource.
878 The bus-specific handle identifying the resource.
880 A pointer to the resource returned by bhnd_alloc_resource.
885 function frees a resource previously returned by
888 .Bl -tag -width indent
890 The device holding ownership of the resource.
892 The type of the resource.
894 The bus-specific handle identifying the resource.
896 A pointer to the resource returned by bhnd_alloc_resource.
904 .Bl -tag -width indent
908 A standard bus resource specification previously initialized by
917 .Bl -tag -width "direct"
920 .Vt struct resource .
922 If true, the resource requires bus window remapping before it is MMIO
932 .Bl -ohang -offset indent -compact
946 .Vt struct resource
968 .Bl -tag -width ".Dv BHND_IOCTL_CLK_FORCE" -offset indent
970 Initiate a built-in self-test (BIST).
984 The mask of IOCTL bits reserved for additional core-specific I/O control flags.
994 .Bl -tag -width ".Dv BHND_IOST_BIST_DONE" -offset indent
1010 Set if this core supports 64-bit DMA.
1012 The mask of IOST bits reserved for additional core-specific I/O status flags.
1021 from the backplane-specific agent/config space of the device
1032 from the backplane-specific agent/config space of the device
1042 is backplane-specific, and these functions should only be used for functionality
1083 Any outstanding per-device PMU requests made using
1098 .Bl -hang -width ".Dv BHND_ATTACH_ADAPTER" -offset indent
1100 The bus is resident on a bridged adapter, such as a PCI Wi-Fi device.
1115 .Bl -tag -width "enum_addr" -offset indent
1143 .Bl -tag -width ".Dv BHND_CHIPTYPE_BCMA_ALT" -offset indent -compact
1149 BCMA-compatible variant found in Broadcom Northstar ARM SoCs.
1152 This BCMA-derived interconnect is found in Broadcom BCM33xx DOCSIS SoCs, and
1161 .Bl -tag -width ".Dv BHND_CAP_BP64" -offset indent -compact
1163 The backplane supports 64-bit addressing.
1190 .Bl -tag -width ".Dv BHND_DEVCLASS_SOC_ROUTER"  -offset indent -compact
1251 .Bl -tag -width "core_idx" -offset indent -compact
1253 Vendor identifier (JEP-106, ARM 4-bit continuation encoded)
1268 .Bl -tag -width ".Dv BHND_MFGID_MIPS" -offset indent -compact
1318 .Bl -tag -width "board_srom_rev" -offset indent
1320 Vendor ID of the board manufacturer (PCI-SIG assigned).
1322 Board ID.
1324 Device ID.
1339 field is the Broadcom PCI device ID that most closely matches the
1347 fields default to the PCI Subsystem Vendor ID, PCI Subsystem ID, and PCI
1348 device ID, unless overridden in device NVRAM.
1361 board-level device attributes.
1477 .Bl -tag -width "Fn BHND_MATCH_BOARD_VENDOR vendor" -offset indent
1501 .Bd -literal -offset indent
1513 .Bl -tag -width "Fn BHND_MATCH_CHIP_IPR id pkg hwrev" -offset indent
1514 .It Fn BHND_MATCH_CHIP_ID "id"
1515 Match on chips with an ID equal to
1517 .Fa id
1523 Match on chips with a package ID equal to
1530 .It Fn BHND_MATCH_CHIP_IP "id" "pkg"
1535 .It Fn BHND_MATCH_CHIP_IPR "id" "pkg" "hwrev"
1541 .It Fn BHND_MATCH_CHIP_IR "id" "hwrev"
1549 .Bd -literal -offset indent
1559 .Bl -tag -width "Fn BHND_MATCH_CORE_VENDOR vendor" -offset indent
1561 Match on cores with a vendor ID equal to
1563 .It Fn BHND_MATCH_CORE_ID "id"
1564 Match on cores with a device ID equal to
1565 .Fa id
1579 .It Fn BHND_MATCH_CORE "vendor" "id"
1587 .Bd -literal -offset indent
1605 .Bd -literal -offset indent
1618 .Bl -tag -width "Fn BHND_HWREV_RANGE start end" -offset indent -compact
1666 .Bl -tag -width "quirks_table" -offset indent -compact
1684 .Bl -tag -width ".Dv BHND_DF_ADAPTER" -offset indent -compact
1704 .Bl -ohang -offset indent
1706 Match on devices with a vendor ID equal to
1709 and a core device ID equal to
1715 argument, a pointer to the device-specific quirks table is specified by the
1731 .Bd -literal -offset indent
1742 .Bl -tag -width "quirks_table" -offset indent -compact
1753 .Bl -tag -width "Fn BHND_CHIP_QUIRK chip hwrev flags" -offset indent
1763 on devices with a chip ID equal to
1772 on devices with a chip ID equal to
1786 .Bd -literal -offset indent
1816 .Bl -ohang -width ".Dv BHND_DMA_TRANSLATION_BYTESWAPPED" -offset indent
1823 on big-endian MIPS SoCs.
1825 The translation provides a byte-swapped mapping; write requests will be
1826 byte-swapped before being written to memory, and read requests will be
1827 byte-swapped before being returned.
1830 embedded MIPS SoCs executing in big-endian mode.
1835 .Bl -tag -width ".Dv BHND_DMA_ADDR_64BIT" -offset indent -compact
1837 30-bit DMA
1839 32-bit DMA
1841 64-bit DMA
1847 .Bl -tag -width "addrext_mask"
1849 Host-to-device physical address translation.
1852 Device-addressable address mask.
1857 Device-addressable extended address mask.
1858 If a the per-core BHND DMA engine supports the 'addrext' control field, it can
1863 core providing device-to-host DMA address translation \(em is handled
1866 For example, on PCI Wi-Fi devices, the Wi-Fi core's DMA engine will (in effect)
1892 Interrupt vector assignments are backplane-specific: On BCMA devices, this
1905 Until unmapped, this IRQ may be used when allocating a resource of type
1952 .Bl -tag -width ".Dv BHND_NVRAM_TYPE_UINT64_ARRAY" -offset indent -compact
1954 unsigned 8-bit integer
1956 unsigned 16-bit integer
1958 unsigned 32-bit integer
1960 signed 64-bit integer
1962 signed 8-bit integer
1964 signed 16-bit integer
1966 signed 32-bit integer
1968 signed 64-bit integer
1970 UTF-8 character
1972 UTF-8 NUL-terminated string
1996 array of UTF-8 characters
1998 array of UTF-8 NUL-terminated strings
2052 coerced to a signed or unsigned 8, 16, or 32-bit integer type.
2058 coerced to a NUL-terminated string.
2088 Per-device interconnect memory mappings are identified by a combination of
2099 .Bl -tag -width ".Dv BHND_PORT_DEVICE" -offset indent
2105 resource ID of 0.
2114 function is used to decode the resource ID
2118 of resource type
2137 function returns the resource ID for the
2139 resource mapping the
2147 or -1 if the port or region are invalid, or do not have an assigned resource ID.
2195 function is used to allocate per-device PMU state and enable PMU request
2213 function releases the per-device PMU state previously allocated for device
2217 Any outstanding clock and external resource requests will be discarded upon
2234 .Bl -tag -width ".Dv BHND_CLOCK_DYN" -offset indent
2241 Idle Low-Power (ILP) Clock.
2245 Active Low-Power (ALP) Clock.
2246 Supports low-latency register access and low-rate DMA.
2249 Supports high bus throughput and lowest-latency register access.
2274 latency value is suitable for use as the D11 Wi-Fi core
2280 function is used to request that the external PMU-managed resource assigned to
2283 identified by device-specific identifier
2291 for the PMU-managed resource identified by device-specific identifier
2293 If an external resource is shared by multiple devices, it will not be powered
2308 .Bl -tag -width ".Dv BHND_SERVICE_INVALID" -offset indent
2390 function looks up the BHND class, if known, for the BHND vendor ID
2392 and device ID
2397 function is used to fetch the human-readable name, if known, for the BHND core
2398 with a vendor ID of
2400 and device ID of
2420 function writes a NUL-terminated human-readable representation of the BHND
2427 .Fa size-1
2458 function returns the human-readable name for the JEP-106, ARM 4-bit
2459 continuation encoded manufacturer ID
2464 .Ss Bus Resource Functions
2478 .Vt "struct resource"
2487 .Bl -tag -width Er
2519 .Bl -tag -width Er
2557 .Bl -tag -width Er
2582 function returns the resource ID for the requested port and region,
2583 or -1 if the port or region are invalid, or do not have an assigned resource ID.
2605 .Bl -tag -width Er
2660 .An -nosplit