Commit 453bbea8 authored by John Stultz's avatar John Stultz Committed by Greg Kroah-Hartman
Browse files

greybus: Move briged phy structure definitions into gpbridge.h 



In order to facilitate re-use of the gpio, i2c, pwm and i2s
structures, split them out of independent files and add
them into a shared gpbridge.h

This will be a prereq to sharing these headers w/ gbsim.

Cc: Alex Elder <alex.elder@linaro.org>
Cc: Greg Kroah-Hartman <gregkh@google.com>
CC: Johan Hovold <johan@hovoldconsulting.com>
Signed-off-by: default avatarJohn Stultz <john.stultz@linaro.org>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@google.com>
parent b0235b22

drivers/staging/greybus/i2s.h→drivers/staging/greybus/gpbridge.h

+270 −3
Original line number Diff line number Diff line 
#ifndef __GB_I2S_H__

#define __GB_I2S_H__

#ifndef __GB_GPBRIDGE_H__

#define __GB_GPBRIDGE_H__

/*

 * This file is provided under a dual BSD/GPLv2 license.  When using or

 * redistributing this file, you may do so under either license.

 *

 * GPL LICENSE SUMMARY

 *

 * Copyright(c) 2014 - 2015 Google Inc. All rights reserved.

 * Copyright(c) 2014 - 2015 Linaro Ltd. All rights reserved.

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of version 2 of the GNU General Public License as

 * published by the Free Software Foundation.

 *

 * This program is distributed in the hope that it will be useful, but

 * WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 * General Public License version 2 for more details.

 *

 * BSD LICENSE

 *

 * Copyright(c) 2014 - 2015 Google Inc. All rights reserved.

 * Copyright(c) 2014 - 2015 Linaro Ltd. All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions

 * are met:

 *

 *  * Redistributions of source code must retain the above copyright

 *    notice, this list of conditions and the following disclaimer.

 *  * Redistributions in binary form must reproduce the above copyright

 *    notice, this list of conditions and the following disclaimer in

 *    the documentation and/or other materials provided with the

 *    distribution.

 *  * Neither the name of Google Inc. or Linaro Ltd. nor the names of

 *    its contributors may be used to endorse or promote products

 *    derived from this software without specific prior written

 *    permission.

 *

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GOOGLE INC. OR

 * LINARO LTD. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY

 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */





/* I2C */



/* Version of the Greybus i2c protocol we support */

#define	GB_I2C_VERSION_MAJOR		0x00

#define	GB_I2C_VERSION_MINOR		0x01



/* Greybus i2c request types */

#define	GB_I2C_TYPE_INVALID		0x00

#define	GB_I2C_TYPE_PROTOCOL_VERSION	0x01

#define	GB_I2C_TYPE_FUNCTIONALITY	0x02

#define	GB_I2C_TYPE_TIMEOUT		0x03

#define	GB_I2C_TYPE_RETRIES		0x04

#define	GB_I2C_TYPE_TRANSFER		0x05

#define	GB_I2C_TYPE_RESPONSE		0x80	/* OR'd with rest */



#define	GB_I2C_RETRIES_DEFAULT		3

#define	GB_I2C_TIMEOUT_DEFAULT		1000	/* milliseconds */



/* functionality request has no payload */

struct gb_i2c_functionality_response {

	__le32	functionality;

};



struct gb_i2c_timeout_request {

	__le16	msec;

};

/* timeout response has no payload */



struct gb_i2c_retries_request {

	__u8	retries;

};

/* retries response has no payload */



/*

 * Outgoing data immediately follows the op count and ops array.

 * The data for each write (master -> slave) op in the array is sent

 * in order, with no (e.g. pad) bytes separating them.

 *

 * Short reads cause the entire transfer request to fail So response

 * payload consists only of bytes read, and the number of bytes is

 * exactly what was specified in the corresponding op.  Like

 * outgoing data, the incoming data is in order and contiguous.

 */

struct gb_i2c_transfer_op {

	__le16	addr;

	__le16	flags;

	__le16	size;

};



struct gb_i2c_transfer_request {

	__le16				op_count;

	struct gb_i2c_transfer_op	ops[0];		/* op_count of these */

};

struct gb_i2c_transfer_response {

	__u8				data[0];	/* inbound data */

};





/* GPIO */



/* Version of the Greybus GPIO protocol we support */

#define	GB_GPIO_VERSION_MAJOR		0x00

#define	GB_GPIO_VERSION_MINOR		0x01



/* Greybus GPIO request types */

#define	GB_GPIO_TYPE_INVALID		0x00

#define	GB_GPIO_TYPE_PROTOCOL_VERSION	0x01

#define	GB_GPIO_TYPE_LINE_COUNT		0x02

#define	GB_GPIO_TYPE_ACTIVATE		0x03

#define	GB_GPIO_TYPE_DEACTIVATE		0x04

#define	GB_GPIO_TYPE_GET_DIRECTION	0x05

#define	GB_GPIO_TYPE_DIRECTION_IN	0x06

#define	GB_GPIO_TYPE_DIRECTION_OUT	0x07

#define	GB_GPIO_TYPE_GET_VALUE		0x08

#define	GB_GPIO_TYPE_SET_VALUE		0x09

#define	GB_GPIO_TYPE_SET_DEBOUNCE	0x0a

#define GB_GPIO_TYPE_IRQ_TYPE		0x0b

#define GB_GPIO_TYPE_IRQ_ACK		0x0c

#define GB_GPIO_TYPE_IRQ_MASK		0x0d

#define GB_GPIO_TYPE_IRQ_UNMASK		0x0e

#define GB_GPIO_TYPE_IRQ_EVENT		0x0f

#define	GB_GPIO_TYPE_RESPONSE		0x80	/* OR'd with rest */



#define	GB_GPIO_DEBOUNCE_USEC_DEFAULT	0	/* microseconds */



/* line count request has no payload */

struct gb_gpio_line_count_response {

	__u8	count;

};



struct gb_gpio_activate_request {

	__u8	which;

};

/* activate response has no payload */



struct gb_gpio_deactivate_request {

	__u8	which;

};

/* deactivate response has no payload */



struct gb_gpio_get_direction_request {

	__u8	which;

};

struct gb_gpio_get_direction_response {

	__u8	direction;

};



struct gb_gpio_direction_in_request {

	__u8	which;

};

/* direction in response has no payload */



struct gb_gpio_direction_out_request {

	__u8	which;

	__u8	value;

};

/* direction out response has no payload */



struct gb_gpio_get_value_request {

	__u8	which;

};

struct gb_gpio_get_value_response {

	__u8	value;

};



struct gb_gpio_set_value_request {

	__u8	which;

	__u8	value;

};

/* set value response has no payload */



struct gb_gpio_set_debounce_request {

	__u8	which;

	__le16	usec __packed;

};

/* debounce response has no payload */



struct gb_gpio_irq_type_request {

	__u8	which;

	__u8	type;

};

/* irq type response has no payload */



struct gb_gpio_irq_mask_request {

	__u8	which;

};

/* irq mask response has no payload */



struct gb_gpio_irq_unmask_request {

	__u8	which;

};

/* irq unmask response has no payload */



struct gb_gpio_irq_ack_request {

	__u8	which;

};

/* irq ack response has no payload */



/* irq event requests originate on another module and are handled on the AP */

struct gb_gpio_irq_event_request {

	__u8	which;

};

/* irq event response has no payload */





/* PWM */



/* Version of the Greybus PWM protocol we support */

#define	GB_PWM_VERSION_MAJOR		0x00

#define	GB_PWM_VERSION_MINOR		0x01



/* Greybus PWM request types */

#define	GB_PWM_TYPE_INVALID		0x00

#define	GB_PWM_TYPE_PROTOCOL_VERSION	0x01

#define	GB_PWM_TYPE_PWM_COUNT		0x02

#define	GB_PWM_TYPE_ACTIVATE		0x03

#define	GB_PWM_TYPE_DEACTIVATE		0x04

#define	GB_PWM_TYPE_CONFIG		0x05

#define	GB_PWM_TYPE_POLARITY		0x06

#define	GB_PWM_TYPE_ENABLE		0x07

#define	GB_PWM_TYPE_DISABLE		0x08

#define	GB_PWM_TYPE_RESPONSE		0x80	/* OR'd with rest */



/* pwm count request has no payload */

struct gb_pwm_count_response {

	__u8	count;

};



struct gb_pwm_activate_request {

	__u8	which;

};



struct gb_pwm_deactivate_request {

	__u8	which;

};



struct gb_pwm_config_request {

	__u8	which;

	__le32	duty __packed;

	__le32	period __packed;

};



struct gb_pwm_polarity_request {

	__u8	which;

	__u8	polarity;

};



struct gb_pwm_enable_request {

	__u8	which;

};



struct gb_pwm_disable_request {

	__u8	which;

};



/* I2S */

#ifndef BIT

#define BIT(n) (1UL << (n))

#endif
@@ -142,4 +409,4 @@ struct gb_i2s_send_data_request { 
};

/* send data has no response at all */



#endif /* __GB_I2S_H__ */
 
#endif /* __GB_GPBRIDGE_H__ */

drivers/staging/greybus/gpio.c

+1 −104
Original line number Diff line number Diff line
@@ -14,6 +14,7 @@ 
#include <linux/irq.h>

#include <linux/irqdomain.h>

#include "greybus.h"

#include "gpbridge.h"



struct gb_gpio_line {

	/* The following has to be an array of line_max entries */
@@ -43,110 +44,6 @@ struct gb_gpio_controller { 
	container_of(chip, struct gb_gpio_controller, chip)

#define irq_data_to_gpio_chip(d) (d->domain->host_data)



/* Version of the Greybus GPIO protocol we support */

#define	GB_GPIO_VERSION_MAJOR		0x00

#define	GB_GPIO_VERSION_MINOR		0x01



/* Greybus GPIO request types */

#define	GB_GPIO_TYPE_INVALID		0x00

#define	GB_GPIO_TYPE_PROTOCOL_VERSION	0x01

#define	GB_GPIO_TYPE_LINE_COUNT		0x02

#define	GB_GPIO_TYPE_ACTIVATE		0x03

#define	GB_GPIO_TYPE_DEACTIVATE		0x04

#define	GB_GPIO_TYPE_GET_DIRECTION	0x05

#define	GB_GPIO_TYPE_DIRECTION_IN	0x06

#define	GB_GPIO_TYPE_DIRECTION_OUT	0x07

#define	GB_GPIO_TYPE_GET_VALUE		0x08

#define	GB_GPIO_TYPE_SET_VALUE		0x09

#define	GB_GPIO_TYPE_SET_DEBOUNCE	0x0a

#define GB_GPIO_TYPE_IRQ_TYPE		0x0b

#define GB_GPIO_TYPE_IRQ_ACK		0x0c

#define GB_GPIO_TYPE_IRQ_MASK		0x0d

#define GB_GPIO_TYPE_IRQ_UNMASK		0x0e

#define GB_GPIO_TYPE_IRQ_EVENT		0x0f

#define	GB_GPIO_TYPE_RESPONSE		0x80	/* OR'd with rest */



#define	GB_GPIO_DEBOUNCE_USEC_DEFAULT	0	/* microseconds */



/* line count request has no payload */

struct gb_gpio_line_count_response {

	__u8	count;

};



struct gb_gpio_activate_request {

	__u8	which;

};

/* activate response has no payload */



struct gb_gpio_deactivate_request {

	__u8	which;

};

/* deactivate response has no payload */



struct gb_gpio_get_direction_request {

	__u8	which;

};

struct gb_gpio_get_direction_response {

	__u8	direction;

};



struct gb_gpio_direction_in_request {

	__u8	which;

};

/* direction in response has no payload */



struct gb_gpio_direction_out_request {

	__u8	which;

	__u8	value;

};

/* direction out response has no payload */



struct gb_gpio_get_value_request {

	__u8	which;

};

struct gb_gpio_get_value_response {

	__u8	value;

};



struct gb_gpio_set_value_request {

	__u8	which;

	__u8	value;

};

/* set value response has no payload */



struct gb_gpio_set_debounce_request {

	__u8	which;

	__le16	usec __packed;

};

/* debounce response has no payload */



struct gb_gpio_irq_type_request {

	__u8	which;

	__u8	type;

};

/* irq type response has no payload */



struct gb_gpio_irq_mask_request {

	__u8	which;

};

/* irq mask response has no payload */



struct gb_gpio_irq_unmask_request {

	__u8	which;

};

/* irq unmask response has no payload */



struct gb_gpio_irq_ack_request {

	__u8	which;

};

/* irq ack response has no payload */



/* irq event requests originate on another module and are handled on the AP */

struct gb_gpio_irq_event_request {

	__u8	which;

};

/* irq event response has no payload */



/* Define get_version() routine */

define_get_version(gb_gpio_controller, GPIO);

drivers/staging/greybus/i2c.c

+2 −55
Original line number Diff line number Diff line
@@ -13,6 +13,8 @@ 
#include <linux/i2c.h>



#include "greybus.h"

#include "gpbridge.h"





struct gb_i2c_device {

	struct gb_connection	*connection;
@@ -26,61 +28,6 @@ struct gb_i2c_device { 
	struct i2c_adapter	adapter;

};



/* Version of the Greybus i2c protocol we support */

#define	GB_I2C_VERSION_MAJOR		0x00

#define	GB_I2C_VERSION_MINOR		0x01



/* Greybus i2c request types */

#define	GB_I2C_TYPE_INVALID		0x00

#define	GB_I2C_TYPE_PROTOCOL_VERSION	0x01

#define	GB_I2C_TYPE_FUNCTIONALITY	0x02

#define	GB_I2C_TYPE_TIMEOUT		0x03

#define	GB_I2C_TYPE_RETRIES		0x04

#define	GB_I2C_TYPE_TRANSFER		0x05

#define	GB_I2C_TYPE_RESPONSE		0x80	/* OR'd with rest */



#define	GB_I2C_RETRIES_DEFAULT		3

#define	GB_I2C_TIMEOUT_DEFAULT		1000	/* milliseconds */



/* functionality request has no payload */

struct gb_i2c_functionality_response {

	__le32	functionality;

};



struct gb_i2c_timeout_request {

	__le16	msec;

};

/* timeout response has no payload */



struct gb_i2c_retries_request {

	__u8	retries;

};

/* retries response has no payload */



/*

 * Outgoing data immediately follows the op count and ops array.

 * The data for each write (master -> slave) op in the array is sent

 * in order, with no (e.g. pad) bytes separating them.

 *

 * Short reads cause the entire transfer request to fail So response

 * payload consists only of bytes read, and the number of bytes is

 * exactly what was specified in the corresponding op.  Like

 * outgoing data, the incoming data is in order and contiguous.

 */

struct gb_i2c_transfer_op {

	__le16	addr;

	__le16	flags;

	__le16	size;

};



struct gb_i2c_transfer_request {

	__le16				op_count;

	struct gb_i2c_transfer_op	ops[0];		/* op_count of these */

};

struct gb_i2c_transfer_response {

	__u8				data[0];	/* inbound data */

};



/* Define get_version() routine */

define_get_version(gb_i2c_device, I2C);

drivers/staging/greybus/pwm.c

+1 −47
Original line number Diff line number Diff line
@@ -12,6 +12,7 @@ 
#include <linux/slab.h>

#include <linux/pwm.h>

#include "greybus.h"

#include "gpbridge.h"



struct gb_pwm_chip {

	struct gb_connection	*connection;
@@ -25,53 +26,6 @@ struct gb_pwm_chip { 
#define pwm_chip_to_gb_pwm_chip(chip) \

	container_of(chip, struct gb_pwm_chip, chip)



/* Version of the Greybus PWM protocol we support */

#define	GB_PWM_VERSION_MAJOR		0x00

#define	GB_PWM_VERSION_MINOR		0x01



/* Greybus PWM request types */

#define	GB_PWM_TYPE_INVALID		0x00

#define	GB_PWM_TYPE_PROTOCOL_VERSION	0x01

#define	GB_PWM_TYPE_PWM_COUNT		0x02

#define	GB_PWM_TYPE_ACTIVATE		0x03

#define	GB_PWM_TYPE_DEACTIVATE		0x04

#define	GB_PWM_TYPE_CONFIG		0x05

#define	GB_PWM_TYPE_POLARITY		0x06

#define	GB_PWM_TYPE_ENABLE		0x07

#define	GB_PWM_TYPE_DISABLE		0x08

#define	GB_PWM_TYPE_RESPONSE		0x80	/* OR'd with rest */



/* pwm count request has no payload */

struct gb_pwm_count_response {

	__u8	count;

};



struct gb_pwm_activate_request {

	__u8	which;

};



struct gb_pwm_deactivate_request {

	__u8	which;

};



struct gb_pwm_config_request {

	__u8	which;

	__le32	duty __packed;

	__le32	period __packed;

};



struct gb_pwm_polarity_request {

	__u8	which;

	__u8	polarity;

};



struct gb_pwm_enable_request {

	__u8	which;

};



struct gb_pwm_disable_request {

	__u8	which;

};



/* Define get_version() routine */

define_get_version(gb_pwm_chip, PWM);