Access.cpp 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318
  1. /*
  2. * Copyright (c) 2020, Liav A. <liavalb@hotmail.co.il>
  3. * All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. *
  8. * 1. Redistributions of source code must retain the above copyright notice, this
  9. * list of conditions and the following disclaimer.
  10. *
  11. * 2. Redistributions in binary form must reproduce the above copyright notice,
  12. * this list of conditions and the following disclaimer in the documentation
  13. * and/or other materials provided with the distribution.
  14. *
  15. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  16. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  19. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  23. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25. */
  26. #include <Kernel/Debug.h>
  27. #include <Kernel/IO.h>
  28. #include <Kernel/PCI/Access.h>
  29. #include <Kernel/PCI/IOAccess.h>
  30. namespace Kernel {
  31. namespace PCI {
  32. static Access* s_access;
  33. inline void write8(Address address, u32 field, u8 value) { Access::the().write8_field(address, field, value); }
  34. inline void write16(Address address, u32 field, u16 value) { Access::the().write16_field(address, field, value); }
  35. inline void write32(Address address, u32 field, u32 value) { Access::the().write32_field(address, field, value); }
  36. inline u8 read8(Address address, u32 field) { return Access::the().read8_field(address, field); }
  37. inline u16 read16(Address address, u32 field) { return Access::the().read16_field(address, field); }
  38. inline u32 read32(Address address, u32 field) { return Access::the().read32_field(address, field); }
  39. Access& Access::the()
  40. {
  41. if (s_access == nullptr) {
  42. ASSERT_NOT_REACHED(); // We failed to initialize the PCI subsystem, so stop here!
  43. }
  44. return *s_access;
  45. }
  46. bool Access::is_initialized()
  47. {
  48. return (s_access != nullptr);
  49. }
  50. Access::Access()
  51. {
  52. s_access = this;
  53. }
  54. PhysicalID Access::get_physical_id(Address address) const
  55. {
  56. for (auto physical_id : m_physical_ids) {
  57. if (physical_id.address().seg() == address.seg()
  58. && physical_id.address().bus() == address.bus()
  59. && physical_id.address().slot() == address.slot()
  60. && physical_id.address().function() == address.function()) {
  61. return physical_id;
  62. }
  63. }
  64. ASSERT_NOT_REACHED();
  65. }
  66. u8 Access::early_read8_field(Address address, u32 field)
  67. {
  68. dbgln<PCI_DEBUG>("PCI: Early reading 8-bit field {:#08x} for {}", field, address);
  69. IO::out32(PCI_ADDRESS_PORT, address.io_address_for_field(field));
  70. return IO::in8(PCI_VALUE_PORT + (field & 3));
  71. }
  72. u16 Access::early_read16_field(Address address, u32 field)
  73. {
  74. dbgln<PCI_DEBUG>("PCI: Early reading 16-bit field {:#08x} for {}", field, address);
  75. IO::out32(PCI_ADDRESS_PORT, address.io_address_for_field(field));
  76. return IO::in16(PCI_VALUE_PORT + (field & 2));
  77. }
  78. u32 Access::early_read32_field(Address address, u32 field)
  79. {
  80. dbgln<PCI_DEBUG>("PCI: Early reading 32-bit field {:#08x} for {}", field, address);
  81. IO::out32(PCI_ADDRESS_PORT, address.io_address_for_field(field));
  82. return IO::in32(PCI_VALUE_PORT);
  83. }
  84. u16 Access::early_read_type(Address address)
  85. {
  86. dbgln<PCI_DEBUG>("PCI: Early reading type for {}", address);
  87. return (early_read8_field(address, PCI_CLASS) << 8u) | early_read8_field(address, PCI_SUBCLASS);
  88. }
  89. void Access::enumerate_functions(int type, u8 bus, u8 slot, u8 function, Function<void(Address, ID)>& callback)
  90. {
  91. dbgln<PCI_DEBUG>("PCI: Enumerating function type={}, bus={}, slot={}, function={}", type, bus, slot, function);
  92. Address address(0, bus, slot, function);
  93. if (type == -1 || type == early_read_type(address))
  94. callback(address, { early_read16_field(address, PCI_VENDOR_ID), early_read16_field(address, PCI_DEVICE_ID) });
  95. if (early_read_type(address) == PCI_TYPE_BRIDGE) {
  96. u8 secondary_bus = early_read8_field(address, PCI_SECONDARY_BUS);
  97. #if PCI_DEBUG
  98. klog() << "PCI: Found secondary bus: " << secondary_bus;
  99. #endif
  100. ASSERT(secondary_bus != bus);
  101. enumerate_bus(type, secondary_bus, callback);
  102. }
  103. }
  104. void Access::enumerate_slot(int type, u8 bus, u8 slot, Function<void(Address, ID)>& callback)
  105. {
  106. dbgln<PCI_DEBUG>("PCI: Enumerating slot type={}, bus={}, slot={}", type, bus, slot);
  107. Address address(0, bus, slot, 0);
  108. if (early_read16_field(address, PCI_VENDOR_ID) == PCI_NONE)
  109. return;
  110. enumerate_functions(type, bus, slot, 0, callback);
  111. if (!(early_read8_field(address, PCI_HEADER_TYPE) & 0x80))
  112. return;
  113. for (u8 function = 1; function < 8; ++function) {
  114. Address address(0, bus, slot, function);
  115. if (early_read16_field(address, PCI_VENDOR_ID) != PCI_NONE)
  116. enumerate_functions(type, bus, slot, function, callback);
  117. }
  118. }
  119. void Access::enumerate_bus(int type, u8 bus, Function<void(Address, ID)>& callback)
  120. {
  121. dbgln<PCI_DEBUG>("PCI: Enumerating bus type={}, bus={}", type, bus);
  122. for (u8 slot = 0; slot < 32; ++slot)
  123. enumerate_slot(type, bus, slot, callback);
  124. }
  125. void Access::enumerate(Function<void(Address, ID)>& callback) const
  126. {
  127. for (auto& physical_id : m_physical_ids) {
  128. callback(physical_id.address(), physical_id.id());
  129. }
  130. }
  131. void enumerate(Function<void(Address, ID)> callback)
  132. {
  133. Access::the().enumerate(callback);
  134. }
  135. Optional<u8> get_capabilities_pointer(Address address)
  136. {
  137. dbgln<PCI_DEBUG>("PCI: Getting capabilities pointer for {}", address);
  138. if (PCI::read16(address, PCI_STATUS) & (1 << 4)) {
  139. dbgln<PCI_DEBUG>("PCI: Found capabilities pointer for {}", address);
  140. return PCI::read8(address, PCI_CAPABILITIES_POINTER);
  141. }
  142. dbgln<PCI_DEBUG>("PCI: No capabilities pointer for {}", address);
  143. return {};
  144. }
  145. PhysicalID get_physical_id(Address address)
  146. {
  147. return Access::the().get_physical_id(address);
  148. }
  149. Vector<Capability> get_capabilities(Address address)
  150. {
  151. dbgln<PCI_DEBUG>("PCI: Getting capabilities for {}", address);
  152. auto capabilities_pointer = PCI::get_capabilities_pointer(address);
  153. if (!capabilities_pointer.has_value()) {
  154. dbgln<PCI_DEBUG>("PCI: No capabilities for {}", address);
  155. return {};
  156. }
  157. Vector<Capability> capabilities;
  158. auto capability_pointer = capabilities_pointer.value();
  159. while (capability_pointer != 0) {
  160. dbgln<PCI_DEBUG>("PCI: Reading in capability at {:#02x} for {}", capability_pointer, address);
  161. u16 capability_header = PCI::read16(address, capability_pointer);
  162. u8 capability_id = capability_header & 0xff;
  163. capability_pointer = capability_header >> 8;
  164. capabilities.append({ capability_id, capability_pointer });
  165. }
  166. return capabilities;
  167. }
  168. void raw_access(Address address, u32 field, size_t access_size, u32 value)
  169. {
  170. ASSERT(access_size != 0);
  171. if (access_size == 1) {
  172. write8(address, field, value);
  173. return;
  174. }
  175. if (access_size == 2) {
  176. write16(address, field, value);
  177. return;
  178. }
  179. if (access_size == 4) {
  180. write32(address, field, value);
  181. return;
  182. }
  183. ASSERT_NOT_REACHED();
  184. }
  185. ID get_id(Address address)
  186. {
  187. return { read16(address, PCI_VENDOR_ID), read16(address, PCI_DEVICE_ID) };
  188. }
  189. void enable_interrupt_line(Address address)
  190. {
  191. write16(address, PCI_COMMAND, read16(address, PCI_COMMAND) & ~(1 << 10));
  192. }
  193. void disable_interrupt_line(Address address)
  194. {
  195. write16(address, PCI_COMMAND, read16(address, PCI_COMMAND) | 1 << 10);
  196. }
  197. u8 get_interrupt_line(Address address)
  198. {
  199. return read8(address, PCI_INTERRUPT_LINE);
  200. }
  201. u32 get_BAR0(Address address)
  202. {
  203. return read32(address, PCI_BAR0);
  204. }
  205. u32 get_BAR1(Address address)
  206. {
  207. return read32(address, PCI_BAR1);
  208. }
  209. u32 get_BAR2(Address address)
  210. {
  211. return read32(address, PCI_BAR2);
  212. }
  213. u32 get_BAR3(Address address)
  214. {
  215. return read16(address, PCI_BAR3);
  216. }
  217. u32 get_BAR4(Address address)
  218. {
  219. return read32(address, PCI_BAR4);
  220. }
  221. u32 get_BAR5(Address address)
  222. {
  223. return read32(address, PCI_BAR5);
  224. }
  225. u8 get_revision_id(Address address)
  226. {
  227. return read8(address, PCI_REVISION_ID);
  228. }
  229. u8 get_subclass(Address address)
  230. {
  231. return read8(address, PCI_SUBCLASS);
  232. }
  233. u8 get_class(Address address)
  234. {
  235. return read8(address, PCI_CLASS);
  236. }
  237. u8 get_programming_interface(Address address)
  238. {
  239. return read8(address, PCI_PROG_IF);
  240. }
  241. u16 get_subsystem_id(Address address)
  242. {
  243. return read16(address, PCI_SUBSYSTEM_ID);
  244. }
  245. u16 get_subsystem_vendor_id(Address address)
  246. {
  247. return read16(address, PCI_SUBSYSTEM_VENDOR_ID);
  248. }
  249. void enable_bus_mastering(Address address)
  250. {
  251. auto value = read16(address, PCI_COMMAND);
  252. value |= (1 << 2);
  253. value |= (1 << 0);
  254. write16(address, PCI_COMMAND, value);
  255. }
  256. void disable_bus_mastering(Address address)
  257. {
  258. auto value = read16(address, PCI_COMMAND);
  259. value &= ~(1 << 2);
  260. value |= (1 << 0);
  261. write16(address, PCI_COMMAND, value);
  262. }
  263. size_t get_BAR_space_size(Address address, u8 bar_number)
  264. {
  265. // See PCI Spec 2.3, Page 222
  266. ASSERT(bar_number < 6);
  267. u8 field = (PCI_BAR0 + (bar_number << 2));
  268. u32 bar_reserved = read32(address, field);
  269. write32(address, field, 0xFFFFFFFF);
  270. u32 space_size = read32(address, field);
  271. write32(address, field, bar_reserved);
  272. space_size &= 0xfffffff0;
  273. space_size = (~space_size) + 1;
  274. return space_size;
  275. }
  276. }
  277. }