1ded66d0fSJason Ling /*
2ded66d0fSJason Ling * Copyright 2018 Google Inc.
3ded66d0fSJason Ling *
4ded66d0fSJason Ling * Licensed under the Apache License, Version 2.0 (the "License");
5ded66d0fSJason Ling * you may not use this file except in compliance with the License.
6ded66d0fSJason Ling * You may obtain a copy of the License at
7ded66d0fSJason Ling *
8ded66d0fSJason Ling * http://www.apache.org/licenses/LICENSE-2.0
9ded66d0fSJason Ling *
10ded66d0fSJason Ling * Unless required by applicable law or agreed to in writing, software
11ded66d0fSJason Ling * distributed under the License is distributed on an "AS IS" BASIS,
12ded66d0fSJason Ling * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13ded66d0fSJason Ling * See the License for the specific language governing permissions and
14ded66d0fSJason Ling * limitations under the License.
15ded66d0fSJason Ling */
16ded66d0fSJason Ling
17ded66d0fSJason Ling #include "lpc_aspeed.hpp"
18ded66d0fSJason Ling
19ded66d0fSJason Ling #include "mapper_errors.hpp"
20ded66d0fSJason Ling #include "window_hw_interface.hpp"
21ded66d0fSJason Ling
22ded66d0fSJason Ling #include <fcntl.h>
23ded66d0fSJason Ling #include <linux/aspeed-lpc-ctrl.h>
24ded66d0fSJason Ling #include <linux/kernel.h>
25ded66d0fSJason Ling
26ded66d0fSJason Ling #include <cerrno>
27ded66d0fSJason Ling #include <cstdint>
28ded66d0fSJason Ling #include <cstring>
29ded66d0fSJason Ling #include <memory>
30ded66d0fSJason Ling #include <string>
31ded66d0fSJason Ling #include <utility>
32ded66d0fSJason Ling
33ded66d0fSJason Ling namespace ipmi_flash
34ded66d0fSJason Ling {
35ded66d0fSJason Ling
36ded66d0fSJason Ling const std::string LpcMapperAspeed::lpcControlPath = "/dev/aspeed-lpc-ctrl";
37ded66d0fSJason Ling
38ded66d0fSJason Ling std::unique_ptr<HardwareMapperInterface>
createAspeedMapper(std::uint32_t regionAddress,std::size_t regionSize)39ded66d0fSJason Ling LpcMapperAspeed::createAspeedMapper(std::uint32_t regionAddress,
40ded66d0fSJason Ling std::size_t regionSize)
41ded66d0fSJason Ling {
42ded66d0fSJason Ling /* NOTE: considered using a joint factory to create one or the other, for
43ded66d0fSJason Ling * now, separate factories.
44ded66d0fSJason Ling */
45ded66d0fSJason Ling return std::make_unique<LpcMapperAspeed>(regionAddress, regionSize);
46ded66d0fSJason Ling }
47ded66d0fSJason Ling
close()48ded66d0fSJason Ling void LpcMapperAspeed::close()
49ded66d0fSJason Ling {
50ded66d0fSJason Ling if (mappedRegion)
51ded66d0fSJason Ling {
52ded66d0fSJason Ling sys->munmap(mappedRegion, regionSize);
53ded66d0fSJason Ling mappedRegion = nullptr;
54ded66d0fSJason Ling }
55ded66d0fSJason Ling
56ded66d0fSJason Ling if (mappedFd != -1)
57ded66d0fSJason Ling {
58ded66d0fSJason Ling sys->close(mappedFd);
59ded66d0fSJason Ling mappedFd = -1;
60ded66d0fSJason Ling }
61ded66d0fSJason Ling }
62ded66d0fSJason Ling
mapWindow(std::uint32_t address,std::uint32_t length)63ded66d0fSJason Ling WindowMapResult LpcMapperAspeed::mapWindow(std::uint32_t address,
64ded66d0fSJason Ling std::uint32_t length)
65ded66d0fSJason Ling {
66ded66d0fSJason Ling WindowMapResult result = {};
67ded66d0fSJason Ling static const std::uint32_t MASK_64K = 0xFFFFU;
68ded66d0fSJason Ling const std::uint32_t offset = address & MASK_64K;
69ded66d0fSJason Ling
70ded66d0fSJason Ling if (offset + length > regionSize)
71ded66d0fSJason Ling {
72ded66d0fSJason Ling std::fprintf(stderr,
73ded66d0fSJason Ling "requested window size %" PRIu32 ", offset %#" PRIx32
74ded66d0fSJason Ling " is too large for mem region"
75ded66d0fSJason Ling " of size %zu\n",
76ded66d0fSJason Ling length, offset, regionSize);
77ded66d0fSJason Ling
78ded66d0fSJason Ling result.response = EFBIG;
79ded66d0fSJason Ling result.windowSize = regionSize - offset;
80ded66d0fSJason Ling return result;
81ded66d0fSJason Ling }
82ded66d0fSJason Ling
83ded66d0fSJason Ling struct aspeed_lpc_ctrl_mapping map = {
84ded66d0fSJason Ling .window_type = ASPEED_LPC_CTRL_WINDOW_MEMORY,
85ded66d0fSJason Ling .window_id = 0,
86ded66d0fSJason Ling .flags = 0,
87ded66d0fSJason Ling .addr = address & ~MASK_64K,
88ded66d0fSJason Ling .offset = 0,
89ded66d0fSJason Ling .size = __ALIGN_KERNEL_MASK(offset + length, MASK_64K),
90ded66d0fSJason Ling };
91ded66d0fSJason Ling
92ded66d0fSJason Ling std::fprintf(stderr,
93ded66d0fSJason Ling "requesting Aspeed LPC window at %#" PRIx32 " of size %" PRIu32
94ded66d0fSJason Ling "\n",
95ded66d0fSJason Ling map.addr, map.size);
96ded66d0fSJason Ling
97ded66d0fSJason Ling const auto lpcControlFd = sys->open(lpcControlPath.c_str(), O_RDWR);
98ded66d0fSJason Ling if (lpcControlFd == -1)
99ded66d0fSJason Ling {
100ded66d0fSJason Ling std::fprintf(stderr,
101ded66d0fSJason Ling "cannot open Aspeed LPC kernel control dev \"%s\"\n",
102ded66d0fSJason Ling lpcControlPath.c_str());
103ded66d0fSJason Ling
104ded66d0fSJason Ling result.response = EINVAL;
105ded66d0fSJason Ling return result;
106ded66d0fSJason Ling }
107ded66d0fSJason Ling
108ded66d0fSJason Ling if (sys->ioctl(lpcControlFd, ASPEED_LPC_CTRL_IOCTL_MAP, &map) == -1)
109ded66d0fSJason Ling {
110ded66d0fSJason Ling std::fprintf(stderr, "Failed to ioctl Aspeed LPC map with error %s\n",
111ded66d0fSJason Ling std::strerror(errno));
112ded66d0fSJason Ling sys->close(lpcControlFd);
113ded66d0fSJason Ling
114ded66d0fSJason Ling result.response = EINVAL;
115ded66d0fSJason Ling return result;
116ded66d0fSJason Ling }
117ded66d0fSJason Ling
118ded66d0fSJason Ling sys->close(lpcControlFd);
119ded66d0fSJason Ling
120ded66d0fSJason Ling result.response = 0;
121ded66d0fSJason Ling result.windowOffset = offset;
122ded66d0fSJason Ling result.windowSize = length;
123ded66d0fSJason Ling return result;
124ded66d0fSJason Ling }
125ded66d0fSJason Ling
open()126ded66d0fSJason Ling MemorySet LpcMapperAspeed::open()
127ded66d0fSJason Ling {
128ded66d0fSJason Ling if (mapRegion())
129ded66d0fSJason Ling {
130ded66d0fSJason Ling MemorySet output;
131ded66d0fSJason Ling output.mappedFd = mappedFd;
132ded66d0fSJason Ling output.mapped = mappedRegion;
133ded66d0fSJason Ling return output;
134ded66d0fSJason Ling }
135ded66d0fSJason Ling
136ded66d0fSJason Ling throw MapperException("Unable to memory-map region");
137ded66d0fSJason Ling }
138ded66d0fSJason Ling
mapRegion()139ded66d0fSJason Ling bool LpcMapperAspeed::mapRegion()
140ded66d0fSJason Ling {
141ded66d0fSJason Ling /* Open the file to map. */
142ded66d0fSJason Ling mappedFd = sys->open(lpcControlPath.c_str(), O_RDONLY | O_SYNC);
143ded66d0fSJason Ling if (mappedFd == -1)
144ded66d0fSJason Ling {
145ded66d0fSJason Ling std::fprintf(stderr, "ipmiflash: unable to open %s\n",
146ded66d0fSJason Ling lpcControlPath.c_str());
147ded66d0fSJason Ling return false;
148ded66d0fSJason Ling }
149ded66d0fSJason Ling
150ded66d0fSJason Ling mappedRegion = reinterpret_cast<uint8_t*>(
151ded66d0fSJason Ling sys->mmap(0, regionSize, PROT_READ, MAP_SHARED, mappedFd, 0));
152ded66d0fSJason Ling
153ded66d0fSJason Ling if (mappedRegion == MAP_FAILED)
154ded66d0fSJason Ling {
155ded66d0fSJason Ling sys->close(mappedFd);
156ded66d0fSJason Ling mappedFd = -1;
157ded66d0fSJason Ling std::fprintf(stderr, "Mmap failure: '%s'\n", std::strerror(errno));
158ded66d0fSJason Ling return false;
159ded66d0fSJason Ling }
160ded66d0fSJason Ling
161*166b4f19SManojkiran Eda /* TODO: There is no close() method here, to close mappedFd, or mappedRegion
162ded66d0fSJason Ling * -- therefore, a good next step will be to evaluate whether or not the
163ded66d0fSJason Ling * other pieces should go here...
164ded66d0fSJason Ling */
165ded66d0fSJason Ling return true;
166ded66d0fSJason Ling }
167ded66d0fSJason Ling
168ded66d0fSJason Ling } // namespace ipmi_flash
169