com.diozero.internal.provider.mmap.MmapDeviceFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of diozero-provider-mmap Show documentation
There is a newer version: 1.2.3
Show newest version
package com.diozero.internal.provider.mmap;

/*
 * #%L
 * Organisation: mattjlewis
 * Project:      Device I/O Zero - High performance mmap GPIO control
 * Filename:     MmapDeviceFactory.java  
 * 
 * This file is part of the diozero project. More information about this project
 * can be found at http://www.diozero.com/
 * %%
 * Copyright (C) 2016 - 2017 mattjlewis
 * %%
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 * #L%
 */

import org.pmw.tinylog.Logger;

import com.diozero.api.*;
import com.diozero.internal.provider.GpioDigitalInputDeviceInterface;
import com.diozero.internal.provider.GpioDigitalInputOutputDeviceInterface;
import com.diozero.internal.provider.GpioDigitalOutputDeviceInterface;
import com.diozero.internal.provider.MmapGpioInterface;
import com.diozero.internal.provider.sysfs.SysFsDeviceFactory;
import com.diozero.util.RuntimeIOException;

public class MmapDeviceFactory extends SysFsDeviceFactory {
	private MmapGpioInterface mmapGpio;
	
	/*
	 * Note this cannot be called in the constructor as createMmapGpio() calls
	 * LibraryLoader.loadLibrary() which in turn calls
	 * DeviceFactoryHelper.getNativeDeviceFactory().getBoardInfo().getLibraryPath()
	 * which causes an infinite loop as this class is constructed by
	 * DeviceFactoryHelper.getNativeDeviceFactory() 
	 */
	synchronized MmapGpioInterface getMmapGpio() {
		if (mmapGpio == null) {
			mmapGpio = getBoardInfo().createMmapGpio();
			if (mmapGpio == null) {
				throw new RuntimeException("Memory mapped GPIO is not supported on board " + getBoardInfo());
			}
			
			mmapGpio.initialise();
		}
		return mmapGpio;
	}
	
	@Override
	public void close() {
		Logger.debug("close()");
		super.close();
		if (mmapGpio != null) {
			mmapGpio.close();
		}
	}

	@Override
	public String getName() {
		return getClass().getSimpleName();
	}

	@Override
	public GpioDigitalInputDeviceInterface createDigitalInputDevice(String key, PinInfo pinInfo, GpioPullUpDown pud,
			GpioEventTrigger trigger) throws RuntimeIOException {
		return new MmapDigitalInputDevice(this, key, pinInfo, pud, trigger);
	}

	@Override
	public GpioDigitalOutputDeviceInterface createDigitalOutputDevice(String key, PinInfo pinInfo, boolean initialValue)
			throws RuntimeIOException {
		return new MmapDigitalOutputDevice(this, key, pinInfo, initialValue);
	}

	@Override
	public GpioDigitalInputOutputDeviceInterface createDigitalInputOutputDevice(String key, PinInfo pinInfo, DeviceMode mode)
			throws RuntimeIOException {
		return new MmapDigitalInputOutputDevice(this, key, pinInfo, mode);
	}
}