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