98
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
/*
* broadsheetfb.c -- FB driver for E-Ink Broadsheet controller
*
* Copyright (C) 2008, Jaya Kumar
*
* This file is subject to the terms and conditions of the GNU General Public
* License. See the file COPYING in the main directory of this archive for
* more details.
*
* Layout is based on skeletonfb.c by James Simmons and Geert Uytterhoeven.
*
* This driver is written to be used with the Broadsheet display controller.
*
* It is intended to be architecture independent. A board specific driver
* must be used to perform all the physical IO interactions.
*
*/
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/string.h>
#include <linux/mm.h>
#include <linux/slab.h>
#include <linux/vmalloc.h>
#include <linux/delay.h>
#include <linux/interrupt.h>
#include <linux/fb.h>
#include <linux/init.h>
#include <linux/platform_device.h>
#include <linux/list.h>
#include <linux/firmware.h>
#include <linux/uaccess.h>
#include <video/broadsheetfb.h>
/* track panel specific parameters */
struct panel_info {
int w;
int h;
u16 sdcfg;
u16 gdcfg;
u16 lutfmt;
u16 fsynclen;
u16 fendfbegin;
u16 lsynclen;
u16 lendlbegin;
u16 pixclk;
};
/* table of panel specific parameters to be indexed into by the board drivers */
static struct panel_info panel_table[] = {
{ /* standard 6" on TFT backplane */
.w = 800,
.h = 600,
.sdcfg = (100 | (1 << 8) | (1 << 9)),
.gdcfg = 2,
.lutfmt = (4 | (1 << 7)),
.fsynclen = 4,
.fendfbegin = (10 << 8) | 4,
.lsynclen = 10,
.lendlbegin = (100 << 8) | 4,
.pixclk = 6,
},
{ /* custom 3.7" flexible on PET or steel */
.w = 320,
.h = 240,
.sdcfg = (67 | (0 << 8) | (0 << 9) | (0 << 10) | (0 << 12)),
.gdcfg = 3,
.lutfmt = (4 | (1 << 7)),
.fsynclen = 0,
.fendfbegin = (80 << 8) | 4,
.lsynclen = 10,
.lendlbegin = (80 << 8) | 20,
.pixclk = 14,
},
{ /* standard 9.7" on TFT backplane */
.w = 1200,
.h = 825,
.sdcfg = (100 | (1 << 8) | (1 << 9) | (0 << 10) | (0 << 12)),
.gdcfg = 2,
.lutfmt = (4 | (1 << 7)),
.fsynclen = 0,
.fendfbegin = (4 << 8) | 4,
.lsynclen = 4,
.lendlbegin = (60 << 8) | 10,
.pixclk = 3,
},
};
#define DPY_W 800
#define DPY_H 600
static struct fb_fix_screeninfo broadsheetfb_fix __devinitdata = {
.id = "broadsheetfb",
.type = FB_TYPE_PACKED_PIXELS,
.visual = FB_VISUAL_STATIC_PSEUDOCOLOR,
.xpanstep = 0,
.ypanstep = 0,
.ywrapstep = 0,
.line_length = DPY_W,
.accel = FB_ACCEL_NONE,
};
static struct fb_var_screeninfo broadsheetfb_var __devinitdata = {
.xres = DPY_W,
.yres = DPY_H,
.xres_virtual = DPY_W,
.yres_virtual = DPY_H,
.bits_per_pixel = 8,
.grayscale = 1,
.red = { 0, 4, 0 },
.green = { 0, 4, 0 },
.blue = { 0, 4, 0 },
.transp = { 0, 0, 0 },
};
/* main broadsheetfb functions */
static void broadsheet_gpio_issue_data(struct broadsheetfb_par *par, u16 data)
{
par->board->set_ctl(par, BS_WR, 0);
par->board->set_hdb(par, data);
par->board->set_ctl(par, BS_WR, 1);
}
static void broadsheet_gpio_issue_cmd(struct broadsheetfb_par *par, u16 data)
{
par->board->set_ctl(par, BS_DC, 0);
broadsheet_gpio_issue_data(par, data);
}
static void broadsheet_gpio_send_command(struct broadsheetfb_par *par, u16 data)
{
par->board->wait_for_rdy(par);
par->board->set_ctl(par, BS_CS, 0);
broadsheet_gpio_issue_cmd(par, data);
par->board->set_ctl(par, BS_DC, 1);
par->board->set_ctl(par, BS_CS, 1);
}
static void broadsheet_gpio_send_cmdargs(struct broadsheetfb_par *par, u16 cmd,
int argc, u16 *argv)
{
int i;
par->board->wait_for_rdy(par);
par->board->set_ctl(par, BS_CS, 0);
broadsheet_gpio_issue_cmd(par, cmd);
par->board->set_ctl(par, BS_DC, 1);
for (i = 0; i < argc; i++)
broadsheet_gpio_issue_data(par, argv[i]);
par->board->set_ctl(par, BS_CS, 1);
}
static void broadsheet_mmio_send_cmdargs(struct broadsheetfb_par *par, u16 cmd,
int argc, u16 *argv)
{
int i;
par->board->mmio_write(par, BS_MMIO_CMD, cmd);
for (i = 0; i < argc; i++)
par->board->mmio_write(par, BS_MMIO_DATA, argv[i]);
}
static void broadsheet_send_command(struct broadsheetfb_par *par, u16 data)
{
if (par->board->mmio_write)
par->board->mmio_write(par, BS_MMIO_CMD, data);
else
broadsheet_gpio_send_command(par, data);
}
static void broadsheet_send_cmdargs(struct broadsheetfb_par *par, u16 cmd,
int argc, u16 *argv)
{
if (par->board->mmio_write)
broadsheet_mmio_send_cmdargs(par, cmd, argc, argv);
else
broadsheet_gpio_send_cmdargs(par, cmd, argc, argv);
}
static void broadsheet_gpio_burst_write(struct broadsheetfb_par *par, int size,
u16 *data)
{
int i;
u16 tmp;
par->board->set_ctl(par, BS_CS, 0);
par->board->set_ctl(par, BS_DC, 1);
for (i = 0; i < size; i++) {
par->board->set_ctl(par, BS_WR, 0);
tmp = (data[i] & 0x0F) << 4;
tmp |= (data[i] & 0x0F00) << 4;
par->board->set_hdb(par, tmp);
par->board->set_ctl(par, BS_WR, 1);
}
par->board->set_ctl(par, BS_CS, 1);
}
static void broadsheet_mmio_burst_write(struct broadsheetfb_par *par, int size,
u16 *data)
{
int i;
u16 tmp;
for (i = 0; i < size; i++) {
tmp = (data[i] & 0x0F) << 4;
tmp |= (data[i] & 0x0F00) << 4;
par->board->mmio_write(par, BS_MMIO_DATA, tmp);
}
}
static void broadsheet_burst_write(struct broadsheetfb_par *par, int size,
u16 *data)
{
if (par->board->mmio_write)
broadsheet_mmio_burst_write(par, size, data);
else
broadsheet_gpio_burst_write(par, size, data);
}
static u16 broadsheet_gpio_get_data(struct broadsheetfb_par *par)
{
u16 res;
/* wait for ready to go hi. (lo is busy) */
par->board->wait_for_rdy(par);
/* cs lo, dc lo for cmd, we lo for each data, db as usual */
par->board->set_ctl(par, BS_DC, 1);
par->board->set_ctl(par, BS_CS, 0);
par->board->set_ctl(par, BS_WR, 0);
res = par->board->get_hdb(par);
/* strobe wr */
par->board->set_ctl(par, BS_WR, 1);
par->board->set_ctl(par, BS_CS, 1);
return res;
}
static u16 broadsheet_get_data(struct broadsheetfb_par *par)
{
if (par->board->mmio_read)
return par->board->mmio_read(par);
else
return broadsheet_gpio_get_data(par);
}
static void broadsheet_gpio_write_reg(struct broadsheetfb_par *par, u16 reg,
u16 data)
{
/* wait for ready to go hi. (lo is busy) */
par->board->wait_for_rdy(par);
/* cs lo, dc lo for cmd, we lo for each data, db as usual */
par->board->set_ctl(par, BS_CS, 0);
broadsheet_gpio_issue_cmd(par, BS_CMD_WR_REG);
par->board->set_ctl(par, BS_DC, 1);
broadsheet_gpio_issue_data(par, reg);
broadsheet_gpio_issue_data(par, data);
par->board->set_ctl(par, BS_CS, 1);
}
static void broadsheet_mmio_write_reg(struct broadsheetfb_par *par, u16 reg,
u16 data)
{
par->board->mmio_write(par, BS_MMIO_CMD, BS_CMD_WR_REG);
par->board->mmio_write(par, BS_MMIO_DATA, reg);
par->board->mmio_write(par, BS_MMIO_DATA, data);
}
static void broadsheet_write_reg(struct broadsheetfb_par *par, u16 reg,
u16 data)
{
if (par->board->mmio_write)
broadsheet_mmio_write_reg(par, reg, data);
else
broadsheet_gpio_write_reg(par, reg, data);
}
static void broadsheet_write_reg32(struct broadsheetfb_par *par, u16 reg,
u32 data)
{
broadsheet_write_reg(par, reg, cpu_to_le32(data) & 0xFFFF);
broadsheet_write_reg(par, reg + 2, (cpu_to_le32(data) >> 16) & 0xFFFF);
}
static u16 broadsheet_read_reg(struct broadsheetfb_par *par, u16 reg)
{
broadsheet_send_cmdargs(par, BS_CMD_RD_REG, 1, ®);
par->board->wait_for_rdy(par);
return broadsheet_get_data(par);
}
/* functions for waveform manipulation */
static int is_broadsheet_pll_locked(struct broadsheetfb_par *par)
{
return broadsheet_read_reg(par, 0x000A) & 0x0001;
}
static int broadsheet_setup_plls(struct broadsheetfb_par *par)
{
int retry_count = 0;
u16 tmp;
/* disable arral saemipu mode */
broadsheet_write_reg(par, 0x0006, 0x0000);
broadsheet_write_reg(par, 0x0010, 0x0004);
broadsheet_write_reg(par, 0x0012, 0x5949);
broadsheet_write_reg(par, 0x0014, 0x0040);
broadsheet_write_reg(par, 0x0016, 0x0000);
do {
if (retry_count++ > 100)
return -ETIMEDOUT;
mdelay(1);
} while (!is_broadsheet_pll_locked(par));
tmp = broadsheet_read_reg(par, 0x0006);
tmp &= ~0x1;
broadsheet_write_reg(par, 0x0006, tmp);
return 0;
}
static int broadsheet_setup_spi(struct broadsheetfb_par *par)
{
broadsheet_write_reg(par, 0x0204, ((3 << 3) | 1));
broadsheet_write_reg(par, 0x0208, 0x0001);
return 0;
}
static int broadsheet_setup_spiflash(struct broadsheetfb_par *par,
u16 *orig_sfmcd)
{
*orig_sfmcd = broadsheet_read_reg(par, 0x0204);
broadsheet_write_reg(par, 0x0208, 0);
broadsheet_write_reg(par, 0x0204, 0);
broadsheet_write_reg(par, 0x0204, ((3 << 3) | 1));
return 0;
}
static int broadsheet_spiflash_wait_for_bit(struct broadsheetfb_par *par,
u16 reg, int bitnum, int val,
int timeout)
{
u16 tmp;
do {
tmp = broadsheet_read_reg(par, reg);
if (((tmp >> bitnum) & 1) == val)
return 0;
mdelay(1);
} while (timeout--);
return -ETIMEDOUT;
}
static int broadsheet_spiflash_write_byte(struct broadsheetfb_par *par, u8 data)
{
broadsheet_write_reg(par, 0x0202, (data | 0x100));
return broadsheet_spiflash_wait_for_bit(par, 0x0206, 3, 0, 100);
}
static int broadsheet_spiflash_read_byte(struct broadsheetfb_par *par, u8 *data)
{
int err;
u16 tmp;
broadsheet_write_reg(par, 0x0202, 0);
err = broadsheet_spiflash_wait_for_bit(par, 0x0206, 3, 0, 100);
if (err)
return err;
tmp = broadsheet_read_reg(par, 0x200);
*data = tmp & 0xFF;
return 0;
}
static int broadsheet_spiflash_wait_for_status(struct broadsheetfb_par *par,
int timeout)
{
u8 tmp;
int err;
do {
broadsheet_write_reg(par, 0x0208, 1);
err = broadsheet_spiflash_write_byte(par, 0x05);
if (err)
goto failout;
err = broadsheet_spiflash_read_byte(par, &tmp);
if (err)
goto failout;
broadsheet_write_reg(par, 0x0208, 0);
if (!(tmp & 0x1))
return 0;
mdelay(5);
} while (timeout--);
dev_err(par->info->device, "Timed out waiting for spiflash status\n");
return -ETIMEDOUT;
failout:
broadsheet_write_reg(par, 0x0208, 0);
return err;
}
static int broadsheet_spiflash_op_on_address(struct broadsheetfb_par *par,
u8 op, u32 addr)
{
int i;
u8 tmp;
int err;
broadsheet_write_reg(par, 0x0208, 1);
err = broadsheet_spiflash_write_byte(par, op);
if (err)
return err;
for (i = 2; i >= 0; i--) {
tmp = ((addr >> (i * 8)) & 0xFF);
err = broadsheet_spiflash_write_byte(par, tmp);
if (err)
return err;
}
return err;
}
static int broadsheet_verify_spiflash(struct broadsheetfb_par *par,
int *flash_type)
{
int err = 0;
u8 sig;
err = broadsheet_spiflash_op_on_address(par, 0xAB, 0x00000000);
if (err)
goto failout;
err = broadsheet_spiflash_read_byte(par, &sig);
if (err)
goto failout;
if ((sig != 0x10) && (sig != 0x11)) {
dev_err(par->info->device, "Unexpected flash type\n");
err = -EINVAL;
goto failout;
}
*flash_type = sig;
failout:
broadsheet_write_reg(par, 0x0208, 0);
return err;
}
static int broadsheet_setup_for_wfm_write(struct broadsheetfb_par *par,
u16 *initial_sfmcd, int *flash_type)
{
int err;
err = broadsheet_setup_plls(par);
if (err)
return err;
broadsheet_write_reg(par, 0x0106, 0x0203);
err = broadsheet_setup_spi(par);
if (err)
return err;
err = broadsheet_setup_spiflash(par, initial_sfmcd);
if (err)
return err;
return broadsheet_verify_spiflash(par, flash_type);
}
static int broadsheet_spiflash_write_control(struct broadsheetfb_par *par,
int mode)
{
int err;
broadsheet_write_reg(par, 0x0208, 1);
if (mode)
err = broadsheet_spiflash_write_byte(par, 0x06);
else
err = broadsheet_spiflash_write_byte(par, 0x04);
broadsheet_write_reg(par, 0x0208, 0);
return err;
}
static int broadsheet_spiflash_erase_sector(struct broadsheetfb_par *par,
int addr)
{
int err;
broadsheet_spiflash_write_control(par, 1);
err = broadsheet_spiflash_op_on_address(par, 0xD8, addr);
broadsheet_write_reg(par, 0x0208, 0);
if (err)
return err;
err = broadsheet_spiflash_wait_for_status(par, 1000);
return err;
}
static int broadsheet_spiflash_read_range(struct broadsheetfb_par *par,
int addr, int size, char *data)
{
int err;
int i;
err = broadsheet_spiflash_op_on_address(par, 0x03, addr);
if (err)
goto failout;
for (i = 0; i < size; i++) {
err = broadsheet_spiflash_read_byte(par, &data[i]);
if (err)
goto failout;
}
failout:
broadsheet_write_reg(par, 0x0208, 0);
return err;
}
#define BS_SPIFLASH_PAGE_SIZE 256
static int broadsheet_spiflash_write_page(struct broadsheetfb_par *par,
int addr, const char *data)
{
int err;
int i;